org.biojava.nbio.structure.symmetry.core

Enum 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>

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 Summary

Enum Constants

Enum Constant and Description
CUSTOM The strategy is defined via an external function, we do not have to do anything.
CYCLE Cycle through the alphabet (e.g., ...xyzABC...)
DOUBLE Represent every cluster with two symbols from the alphabet, this forces us to specify number of subunits for every subunit (e.g., AA1AB1AC1...).
QUESTIONMARK Put '?'

Method Summary

Modifier and Type	Method and Description
static Stoichiometry.StringOverflowStrategy	valueOf(String name) Returns the enum constant of this type with the specified name.
static Stoichiometry.StringOverflowStrategy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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 Detail

values

public static Stoichiometry.StringOverflowStrategy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Stoichiometry.StringOverflowStrategy c : Stoichiometry.StringOverflowStrategy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

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