Package pl.poznan.put.notation

Enum BPh

java.lang.Object
java.lang.Enum<BPh>
pl.poznan.put.notation.BPh
All Implemented Interfaces:
Serializable, Comparable<BPh>, java.lang.constant.Constable
public enum BPh extends Enum<BPh>
A base-phosphate notation described in: Classification and Energetics of the Base-Phosphate Interactions in RNA. C.L. Zirbel, J.E. Šponer, J. Šponer, J. Stombaugh, N.B. Leontis. Nucleic Acids Research. 2009. 37(15):4898–4918. doi:10.1093/nar/gkp468

  • Enum Constant Details

    • _0

      public static final BPh _0

    • _1

      public static final BPh _1

    • _2

      public static final BPh _2

    • _3

      public static final BPh _3

    • _4

      public static final BPh _4

    • _5

      public static final BPh _5

    • _6

      public static final BPh _6

    • _7

      public static final BPh _7

    • _8

      public static final BPh _8

    • _9

      public static final BPh _9

    • UNKNOWN

      public static final BPh UNKNOWN

  • Method Details

    • values

      public static BPh[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static BPh valueOf(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:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • fromString

      public static BPh fromString(String candidate)
      Finds an enum constant that matches the given one or return a predefined UNKNOWN value.
      Parameters:
      candidate - A string representing a BPh value.
      Returns:
      An instance of this class that matches given name or UNKNOWN if none does.

    • displayName

      public String displayName()
      Returns:
      The default display name.