org.biojava3.alignment.template

Enum AlignedSequence.Step

java.lang.Object

java.lang.Enum<AlignedSequence.Step>

org.biojava3.alignment.template.AlignedSequence.Step

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AlignedSequence.Step>

Enclosing interface:

AlignedSequence<S extends Sequence<C>,C extends Compound>

public static enum AlignedSequence.Step
extends java.lang.Enum<AlignedSequence.Step>

Defines an alignment step in order to pass alignment information from an Aligner to a constructor.

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPOUND
GAP

Method Summary

Methods

Modifier and Type	Method and Description
static AlignedSequence.Step	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AlignedSequence.Step[]	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

COMPOUND

public static final AlignedSequence.Step COMPOUND

GAP

public static final AlignedSequence.Step GAP

Method Detail

values

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

Returns:

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

valueOf

public static AlignedSequence.Step valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null