Enum Class Stoichiometry.StringOverflowStrategy

java.lang.Object
java.lang.Enum<Stoichiometry.StringOverflowStrategy>
org.biojava.nbio.structure.symmetry.core.Stoichiometry.StringOverflowStrategy
All Implemented Interfaces:
Serializable, Comparable<Stoichiometry.StringOverflowStrategy>, Constable
Enclosing class:
Stoichiometry

public static enum Stoichiometry.StringOverflowStrategy extends Enum<Stoichiometry.StringOverflowStrategy>
What to do when the number of SubunitCluster exceeds the length of the alphabet.
  • Enum Constant Details

    • QUESTIONMARK

      public static final Stoichiometry.StringOverflowStrategy QUESTIONMARK
      Put '?' symbol for every (alphabet.length+i)-th cluster
    • CYCLE

      public static final Stoichiometry.StringOverflowStrategy CYCLE
      Cycle through the alphabet (e.g., ...xyzABC...)
    • DOUBLE

      public static final Stoichiometry.StringOverflowStrategy DOUBLE
      Represent every cluster with two symbols from the alphabet, this forces us to specify number of subunits for every subunit (e.g., AA1AB1AC1...). This strategy will not work correctly if there are more than alphabet.length^2 subunit clusters.
    • CUSTOM

      public static final Stoichiometry.StringOverflowStrategy CUSTOM
      The strategy is defined via an external function, we do not have to do anything.
  • Method Details

    • values

      public static Stoichiometry.StringOverflowStrategy[] 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 Stoichiometry.StringOverflowStrategy 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