fr.ifremer.adagio.core.dao.referential.location

Enum LocationLabel

Object

Enum<LocationLabel>

LocationLabel

All Implemented Interfaces:

AdagioEnumerationDef<String>, Serializable, Comparable<LocationLabel>

public enum LocationLabel
extends Enum<LocationLabel>
implements Serializable, AdagioEnumerationDef<String>

Enum Constant Summary

Enum Constants

Enum Constant and Description
FRANCE TODO: Model Documentation for Enumeration Literal FRANCE value "FRA"
MEDITERRANEAN_AND_BLACK_SEA TODO: Model Documentation for Enumeration Literal MEDITERRANEAN_AND_BLACK_SEA value "37"

Field Summary

Fields inherited from interface AdagioEnumerationDef

CONFIG_OPTION_PREFIX

Method Summary

Methods

Modifier and Type	Method and Description
static LocationLabel	fromString(String name) Retrieves an instance of LocationLabel from its name.
static LocationLabel	fromValue(String value) Returns an instance of LocationLabel from String value.
String	getDescription()
String	getKey()
Class<?>	getType()
String	getValue() Gets the underlying value of this type safe enumeration.
String	getValueAsString()
static List<String>	literals() Returns an unmodifiable list containing the literals that are known by this enumeration.
static List<String>	names() Returns an unmodifiable list containing the names of the literals that are known by this enumeration.
void	setValue(String newValue)
String	value() Returns an enumeration literal String value.
static LocationLabel	valueOf(String name) Returns the enum constant of this type with the specified name.
static LocationLabel[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FRANCE

public static final LocationLabel FRANCE

TODO: Model Documentation for Enumeration Literal FRANCE value "FRA"

MEDITERRANEAN_AND_BLACK_SEA

public static final LocationLabel MEDITERRANEAN_AND_BLACK_SEA

TODO: Model Documentation for Enumeration Literal MEDITERRANEAN_AND_BLACK_SEA value "37"

Method Detail

values

public static LocationLabel[] 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 (LocationLabel c : LocationLabel.values())
    System.out.println(c);

Returns:

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

valueOf

public static LocationLabel 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

setValue

public void setValue(String newValue)

Specified by:

setValue in interface AdagioEnumerationDef<String>

getValueAsString

public String getValueAsString()

Specified by:

getValueAsString in interface AdagioEnumerationDef<String>

fromString

public static LocationLabel fromString(String name)

Retrieves an instance of LocationLabel from its name.

Parameters:

name - the name to create the LocationLabel from.

Returns:

The enumeration literal named after the 'name' argument

value

public String value()

Returns an enumeration literal String value. Required by JAXB2 enumeration implementation

Returns:

String with corresponding value

fromValue

public static LocationLabel fromValue(String value)

Returns an instance of LocationLabel from String value. Required by JAXB2 enumeration implementation

Parameters:

value - the value to create the LocationLabel from.

Returns:

static Enumeration with corresponding value

getValue

public String getValue()

Gets the underlying value of this type safe enumeration. This method is necessary to comply with DaoBase implementation.

Specified by:

getValue in interface AdagioEnumerationDef<String>

Returns:

The name of this literal.

getDescription

public String getDescription()

Specified by:

getDescription in interface AdagioEnumerationDef<String>

getKey

public String getKey()

Specified by:

getKey in interface AdagioEnumerationDef<String>

getType

public Class<?> getType()

Specified by:

getType in interface AdagioEnumerationDef<String>

literals

public static List<String> literals()

Returns an unmodifiable list containing the literals that are known by this enumeration.

Returns:

A List containing the actual literals defined by this enumeration, this list can not be modified.

names

public static List<String> names()

Returns an unmodifiable list containing the names of the literals that are known by this enumeration.

Returns:

A List containing the actual names of the literals defined by this enumeration, this list can not be modified.