org.biolegato.core.data.sequence
Enum Sequence.CharacterClass

java.lang.Object
  java.lang.Enum<Sequence.CharacterClass>
      org.biolegato.core.data.sequence.Sequence.CharacterClass

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Sequence.CharacterClass>

Enclosing class:

Sequence

public static enum Sequence.CharacterClass
extends java.lang.Enum<Sequence.CharacterClass>

Used for typing characters within a sequence. This is especially useful for intrinsic functions which rely upon detecting alignment gaps, ambiguous characters and unambiguous characters (such as certain colour maps).

Enum Constant Summary

ALIGNMENT
Alignment gap class.

AMBIGUOUS
Ambiguous character class.

UNAMBIGUOUS
Unambiguous character class.

Method Summary

static Sequence.CharacterClass	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Sequence.CharacterClass[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ALIGNMENT

public static final Sequence.CharacterClass ALIGNMENT

Alignment gap class.

AMBIGUOUS

public static final Sequence.CharacterClass AMBIGUOUS

Ambiguous character class.

UNAMBIGUOUS

public static final Sequence.CharacterClass UNAMBIGUOUS

Unambiguous character class.

Method Detail

values

public static final Sequence.CharacterClass[] values()

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

for(Sequence.CharacterClass c : Sequence.CharacterClass.values())
        System.out.println(c);

Returns:

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

valueOf

public static Sequence.CharacterClass 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