de.jstacs.data.sequences.annotation

Enum StrandedLocatedSequenceAnnotationWithLength.Strand

java.lang.Object

java.lang.Enum<StrandedLocatedSequenceAnnotationWithLength.Strand>

de.jstacs.data.sequences.annotation.StrandedLocatedSequenceAnnotationWithLength.Strand

All Implemented Interfaces:

Serializable, Comparable<StrandedLocatedSequenceAnnotationWithLength.Strand>

Enclosing class:

StrandedLocatedSequenceAnnotationWithLength

public static enum StrandedLocatedSequenceAnnotationWithLength.Strand
extends Enum<StrandedLocatedSequenceAnnotationWithLength.Strand>

This enum defines possible orientations on the strands.

Author:

Jan Grau

Enum Constant Summary

Enum Constants

Enum Constant and Description
FORWARD The annotation is located on the forward strand.
REVERSE The annotation is located on the reverse strand.
UNKNOWN The orientation of the annotation is not known.

Method Summary

Methods

Modifier and Type	Method and Description
String	strandedness() Returns the strandedness, i.e.
static StrandedLocatedSequenceAnnotationWithLength.Strand	valueOf(String name) Returns the enum constant of this type with the specified name.
static StrandedLocatedSequenceAnnotationWithLength.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

FORWARD

public static final StrandedLocatedSequenceAnnotationWithLength.Strand FORWARD

The annotation is located on the forward strand.

REVERSE

public static final StrandedLocatedSequenceAnnotationWithLength.Strand REVERSE

The annotation is located on the reverse strand.

UNKNOWN

public static final StrandedLocatedSequenceAnnotationWithLength.Strand UNKNOWN

The orientation of the annotation is not known.

Method Detail

values

public static StrandedLocatedSequenceAnnotationWithLength.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 (StrandedLocatedSequenceAnnotationWithLength.Strand c : StrandedLocatedSequenceAnnotationWithLength.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 StrandedLocatedSequenceAnnotationWithLength.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

strandedness

public String strandedness()

Returns the strandedness, i.e. the orientation on the strand of the sequence as a String.

Returns:

the strandedness, i.e. the orientation on the strand of the sequence