fr.ifremer.adagio.core.dao.referential.pmfm

Enum MatrixId

Object

Enum<MatrixId>

MatrixId

All Implemented Interfaces:

AdagioEnumerationDef<Integer>, Serializable, Comparable<MatrixId>

public enum MatrixId
extends Enum<MatrixId>
implements Serializable, AdagioEnumerationDef<Integer>

Enum Constant Summary

Enum Constants

Enum Constant and Description
FISHING_METIER TODO: Model Documentation for Enumeration Literal FISHING_METIER value 6
GEAR TODO: Model Documentation for Enumeration Literal GEAR value 3
OPERATION TODO: Model Documentation for Enumeration Literal OPERATION value 21
PRODUCE_BATCH TODO: Model Documentation for Enumeration Literal PRODUCE_BATCH value 1
VESSEL TODO: Model Documentation for Enumeration Literal VESSEL value 5

Field Summary

Fields inherited from interface AdagioEnumerationDef

CONFIG_OPTION_PREFIX

Method Summary

Methods

Modifier and Type	Method and Description
static MatrixId	fromString(String name) Retrieves an instance of MatrixId from its name.
static MatrixId	fromValue(Integer value) Returns an instance of MatrixId from Integer value.
String	getDescription()
String	getKey()
Class<?>	getType()
Integer	getValue() Gets the underlying value of this type safe enumeration.
String	getValueAsString()
static List<Integer>	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(Integer newValue)
Integer	value() Returns an enumeration literal Integer value.
static MatrixId	valueOf(String name) Returns the enum constant of this type with the specified name.
static MatrixId[]	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

GEAR

public static final MatrixId GEAR

TODO: Model Documentation for Enumeration Literal GEAR value 3

VESSEL

public static final MatrixId VESSEL

TODO: Model Documentation for Enumeration Literal VESSEL value 5

FISHING_METIER

public static final MatrixId FISHING_METIER

TODO: Model Documentation for Enumeration Literal FISHING_METIER value 6

OPERATION

public static final MatrixId OPERATION

TODO: Model Documentation for Enumeration Literal OPERATION value 21

PRODUCE_BATCH

public static final MatrixId PRODUCE_BATCH

TODO: Model Documentation for Enumeration Literal PRODUCE_BATCH value 1

Method Detail

values

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

Returns:

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

valueOf

public static MatrixId 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(Integer newValue)

Specified by:

setValue in interface AdagioEnumerationDef<Integer>

getValueAsString

public String getValueAsString()

Specified by:

getValueAsString in interface AdagioEnumerationDef<Integer>

fromString

public static MatrixId fromString(String name)

Retrieves an instance of MatrixId from its name.

Parameters:

name - the name to create the MatrixId from.

Returns:

The enumeration literal named after the 'name' argument

value

public Integer value()

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

Returns:

Integer with corresponding value

fromValue

public static MatrixId fromValue(Integer value)

Returns an instance of MatrixId from Integer value. Required by JAXB2 enumeration implementation

Parameters:

value - the value to create the MatrixId from.

Returns:

static Enumeration with corresponding value

getValue

public Integer 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<Integer>

Returns:

The name of this literal.

getDescription

public String getDescription()

Specified by:

getDescription in interface AdagioEnumerationDef<Integer>

getKey

public String getKey()

Specified by:

getKey in interface AdagioEnumerationDef<Integer>

getType

public Class<?> getType()

Specified by:

getType in interface AdagioEnumerationDef<Integer>

literals

public static List<Integer> 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.