info.bioinfweb.commons.bio

Enum CharacterSymbolType

java.lang.Object

java.lang.Enum<CharacterSymbolType>

info.bioinfweb.commons.bio.CharacterSymbolType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CharacterSymbolType>

public enum CharacterSymbolType
extends java.lang.Enum<CharacterSymbolType>

Enumerates of which type a character symbol may be. It can either represent an atomic character state or a set of polymorphic or uncertain states.

Since:

2.0.0

Author:

Ben Stöver

Enum Constant Summary

Enum Constants

Enum Constant and Description
ATOMIC_STATE Indicates that a character symbol represents a single certain state.
POLYMORPHIC Indicates that a character symbol represents a set of states which form a polymorphic state.
UNCERTAIN Indicates that a character symbol represents a set of states, one of which this character could assume.

Method Summary

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

ATOMIC_STATE

public static final CharacterSymbolType ATOMIC_STATE

Indicates that a character symbol represents a single certain state.

POLYMORPHIC

public static final CharacterSymbolType POLYMORPHIC

Indicates that a character symbol represents a set of states which form a polymorphic state.

UNCERTAIN

public static final CharacterSymbolType UNCERTAIN

Indicates that a character symbol represents a set of states, one of which this character could assume.

Method Detail

values

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

Returns:

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

valueOf

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