fr.ifremer.adagio.core.dao.referential

Enum VesselPersonRoleId

Object

Enum<VesselPersonRoleId>

VesselPersonRoleId

All Implemented Interfaces:

AdagioEnumerationDef<Integer>, Serializable, Comparable<VesselPersonRoleId>

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
RECORDER_PERSON TODO: Model Documentation for Enumeration Literal RECORDER_PERSON value 4
SCIENTIFIC_CRUISE_MANAGER TODO: Model Documentation for Enumeration Literal SCIENTIFIC_CRUISE_MANAGER value 2
SORT_ROOM_MANAGER TODO: Model Documentation for Enumeration Literal SORT_ROOM_MANAGER value 3
VESSEL_MASTER TODO: Model Documentation for Enumeration Literal VESSEL_MASTER value 1

Field Summary

Fields inherited from interface AdagioEnumerationDef

CONFIG_OPTION_PREFIX

Method Summary

Methods

Modifier and Type	Method and Description
static VesselPersonRoleId	fromString(String name) Retrieves an instance of VesselPersonRoleId from its name.
static VesselPersonRoleId	fromValue(Integer value) Returns an instance of VesselPersonRoleId 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 VesselPersonRoleId	valueOf(String name) Returns the enum constant of this type with the specified name.
static VesselPersonRoleId[]	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

VESSEL_MASTER

public static final VesselPersonRoleId VESSEL_MASTER

TODO: Model Documentation for Enumeration Literal VESSEL_MASTER value 1

SCIENTIFIC_CRUISE_MANAGER

public static final VesselPersonRoleId SCIENTIFIC_CRUISE_MANAGER

TODO: Model Documentation for Enumeration Literal SCIENTIFIC_CRUISE_MANAGER value 2

SORT_ROOM_MANAGER

public static final VesselPersonRoleId SORT_ROOM_MANAGER

TODO: Model Documentation for Enumeration Literal SORT_ROOM_MANAGER value 3

RECORDER_PERSON

public static final VesselPersonRoleId RECORDER_PERSON

TODO: Model Documentation for Enumeration Literal RECORDER_PERSON value 4

Method Detail

values

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

Returns:

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

valueOf

public static VesselPersonRoleId 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 VesselPersonRoleId fromString(String name)

Retrieves an instance of VesselPersonRoleId from its name.

Parameters:

name - the name to create the VesselPersonRoleId 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 VesselPersonRoleId fromValue(Integer value)

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

Parameters:

value - the value to create the VesselPersonRoleId 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.