Package pl.poznan.put.notation

Enum StackingTopology

java.lang.Object
java.lang.Enum<StackingTopology>
pl.poznan.put.notation.StackingTopology
All Implemented Interfaces:
Serializable, Comparable<StackingTopology>, java.lang.constant.Constable
public enum StackingTopology extends Enum<StackingTopology>
Stacking topologies are described in: New Metrics for Comparing and Assessing Discrepancies between RNA 3D Structures and Models. M. Parisien, J.A. Cruz, E. Westhof, F. Major. RNA. 2009. 15(10):1875–1885. doi:10.1261/rna.1700409

  • Enum Constant Details

  • Method Details

    • values

      public static StackingTopology[] 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 StackingTopology 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 StackingTopology fromString(String candidate)
      Finds an enum constant that matches the given one or return a predefined UNKNOWN value.
      Parameters:
      candidate - A string representing a StackingTopology 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.

    • invert

      public StackingTopology invert()
      Returns:
      An instance where up- and down- or in- and out- are inverted.