org.broadinstitute.hellbender.utils.samples

Enum Affection

java.lang.Object

java.lang.Enum<Affection>

org.broadinstitute.hellbender.utils.samples.Affection

All Implemented Interfaces:

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

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

Categorical sample trait for association and analysis Samples can have unknown status, be affected or unaffected by the categorical trait, or they can be marked as actually having an other trait value (stored in an associated value in the Sample class)

Since:

Sept. 2011

Enum Constant Summary

Enum Constants

Enum Constant and Description
AFFECTED Suffers from the disease
OTHER An "other" trait: value of the trait is stored elsewhere and is an arbitrary string
UNAFFECTED Unaffected by the disease
UNKNOWN Status is unknown

Method Summary

Modifier and Type	Method and Description
static Affection	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Affection[]	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

UNKNOWN

public static final Affection UNKNOWN

Status is unknown

AFFECTED

public static final Affection AFFECTED

Suffers from the disease

UNAFFECTED

public static final Affection UNAFFECTED

Unaffected by the disease

OTHER

public static final Affection OTHER

An "other" trait: value of the trait is stored elsewhere and is an arbitrary string

Method Detail

values

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

Returns:

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

valueOf

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