picard.pedigree

Enum Sex

java.lang.Object

java.lang.Enum<Sex>

picard.pedigree.Sex

All Implemented Interfaces:

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

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

Represents the sex of an individual.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Female
Male
Unknown

Method Summary

Modifier and Type	Method and Description
static Sex	fromCode(int code) Decodes the Sex from a numeric code.
int	toCode() Returns the code used to encode this sex in a ped/fam file.
static Sex	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Sex[]	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 Sex Male

Female

public static final Sex Female

Unknown

public static final Sex Unknown

Method Detail

values

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

Returns:

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

valueOf

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

toCode

public int toCode()

Returns the code used to encode this sex in a ped/fam file.

fromCode

public static Sex fromCode(int code)

Decodes the Sex from a numeric code. Note that any value other than 1 or 2 will return Unknown.