org.biojava3.core.sequence
Enum Strand

java.lang.Object
  extended by java.lang.Enum<Strand>
      extended by org.biojava3.core.sequence.Strand
All Implemented Interfaces:
Serializable, Comparable<Strand>

public enum Strand
extends Enum<Strand>

Provides a way of representing the strand of a sequence, location hit or feature.

Author:
ayates

Enum Constant Summary
NEGATIVE
           
POSITIVE
           
UNDEFINED
           
 
Method Summary
 int getNumericRepresentation()
           
 Strand getReverse()
           
 String getStringRepresentation()
           
static Strand valueOf(String name)
          Returns the enum constant of this type with the specified name.
static Strand[] 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

POSITIVE

public static final Strand POSITIVE

NEGATIVE

public static final Strand NEGATIVE

UNDEFINED

public static final Strand UNDEFINED
Method Detail

values

public static Strand[] 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 (Strand c : Strand.values())
    System.out.println(c);

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

valueOf

public static Strand 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

getNumericRepresentation

public int getNumericRepresentation()

getStringRepresentation

public String getStringRepresentation()

getReverse

public Strand getReverse()