Package org.datanucleus.metadata

Enum IndexedValue

java.lang.Object

java.lang.Enum<IndexedValue>

org.datanucleus.metadata.IndexedValue

All Implemented Interfaces:

Serializable, Comparable<IndexedValue>

public enum IndexedValue
extends Enum<IndexedValue>

Representation of whether an item is indexed or not.

Enum Constant Summary

Enum Constants

Enum Constant	Description
FALSE
TRUE
UNIQUE

Method Summary

Modifier and Type	Method	Description
static IndexedValue	getIndexedValue(String value)	Obtain a IndexedValue for the given name by value
static IndexedValue	valueOf(String name)	Returns the enum constant of this type with the specified name.
static IndexedValue[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TRUE

public static final IndexedValue TRUE

FALSE

public static final IndexedValue FALSE

UNIQUE

public static final IndexedValue UNIQUE

Method Detail

values

public static IndexedValue[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (IndexedValue c : IndexedValue.values())
    System.out.println(c);

Returns:

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

valueOf

public static IndexedValue valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

getIndexedValue

public static IndexedValue getIndexedValue(String value)

Obtain a IndexedValue for the given name by value

Parameters:

value - the name

Returns:

the IndexedValue found or IndexedValue.TRUE if not found. If value is null, returns null.