Package org.broadinstitute.hellbender.utils.samples

Enum Class Affection

java.lang.Object
java.lang.Enum<Affection>
org.broadinstitute.hellbender.utils.samples.Affection
All Implemented Interfaces:
Serializable, Comparable<Affection>, Constable
public enum Affection extends 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 Details

    • 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 Details

    • values

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