Package org.conical.common.bbl.enums

Enum Class Sex

java.lang.Object

java.lang.Enum<Sex>

org.conical.common.bbl.enums.Sex

All Implemented Interfaces:

Serializable, Comparable<Sex>, Constable, Coded, Described, Named

public enum Sex
extends Enum<Sex>
implements Named, Described, Coded

Enum keeps track of the variety of sexes the BBL documents and their attributes

Author:

rdoherty

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
FEMALE
MALE
OTHER

Method Summary

Modifier and Type	Method	Description
int	getCode()	Returns a integer code for this enum value, generally the representative value stored in a database.
String	getDescription()	Returns a human-readable description of what this value is/means or perhaps how it is used
String	getName()	Convenience method to provide getter access to name().
Sex	getOpposite()
static Sex	valueOf(int code)	Returns the enum constant of this class with the specified name.
static Sex	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Sex[]	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

MALE

public static final Sex MALE

FEMALE

public static final Sex FEMALE

OTHER

public static final Sex OTHER

Method Details

values

public static Sex[] 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 Sex 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

getCode

public int getCode()

Returns a integer code for this enum value, generally the representative value stored in a database.

Specified by:

getCode in interface Coded

Returns:

code for this value

getName

public String getName()

Convenience method to provide getter access to name().

Specified by:

getName in interface Named

Returns:

same as name()

getDescription

public String getDescription()

Returns a human-readable description of what this value is/means or perhaps how it is used

Specified by:

getDescription in interface Described

Returns:

enum value description

valueOf

public static Sex valueOf(int code)

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:

code - 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

getOpposite

public Sex getOpposite()