Enum Class LocusFunction

java.lang.Object
java.lang.Enum<LocusFunction>
picard.annotation.LocusFunction
All Implemented Interfaces:
Serializable, Comparable<LocusFunction>, Constable

public enum LocusFunction extends Enum<LocusFunction>
Describes the behavior of a locus relative to a gene. Note that these are enumerated in a specific order: (INTERGENIC, INTRONIC, UTR, CODING, RIBOSOMAL) so that e.g. if a locus is CODING in one gene and UTR in another, we count it as CODING.
  • Enum Constant Details

  • Method Details

    • values

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