Module org.klojang.check

Package org.klojang.check.aux

Enum Class DuplicateValueException.Usage

java.lang.Object

java.lang.Enum<DuplicateValueException.Usage>

org.klojang.check.aux.DuplicateValueException.Usage

All Implemented Interfaces:

Serializable, Comparable<DuplicateValueException.Usage>, Constable

Enclosing class:

DuplicateValueException

public static enum DuplicateValueException.Usage
extends Enum<DuplicateValueException.Usage>

Symbolic constants for the intended usage of the value.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ELEMENT	The value was meant to be inserted into a Set.
KEY	The value was meant to be used as a map key, or possibly some record-like structure.
VALUE	The value was meant to be used for some other uniqueness-enforcing purpose.

Method Summary

Modifier and Type	Method	Description
static DuplicateValueException.Usage	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DuplicateValueException.Usage[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

KEY

public static final DuplicateValueException.Usage KEY

The value was meant to be used as a map key, or possibly some record-like structure.

ELEMENT

public static final DuplicateValueException.Usage ELEMENT

The value was meant to be inserted into a Set.

VALUE

public static final DuplicateValueException.Usage VALUE

The value was meant to be used for some other uniqueness-enforcing purpose.

Method Details

values

public static DuplicateValueException.Usage[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static DuplicateValueException.Usage valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null