net.sf.scuba.data

Enum Gender

java.lang.Object

java.lang.Enum<Gender>

net.sf.scuba.data.Gender

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Gender>

public enum Gender
extends java.lang.Enum<Gender>

Possible values for a person's gender. Integer values correspond to Section 5.5.3 of ISO 19794-5.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FEMALE
MALE
UNKNOWN
UNSPECIFIED

Method Summary

Modifier and Type	Method and Description
static Gender	getInstance(int code) Gets a gender object given a code.
abstract int	toInt() Gets the numerical code of this gender.
static Gender	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Gender[]	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

MALE

public static final Gender MALE

FEMALE

public static final Gender FEMALE

UNKNOWN

public static final Gender UNKNOWN

UNSPECIFIED

public static final Gender UNSPECIFIED

Method Detail

values

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

Returns:

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

valueOf

public static Gender valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

toInt

public abstract int toInt()

Gets the numerical code of this gender.

Returns:

the numerical code

getInstance

public static Gender getInstance(int code)

Gets a gender object given a code.

Parameters:

code - the numerical code

Returns:

a gender