Package org.coordinatekit.crf.annotator

Enum Class FeatureAvailability

java.lang.Object

java.lang.Enum<FeatureAvailability>

org.coordinatekit.crf.annotator.FeatureAvailability

All Implemented Interfaces:

Serializable, Comparable<FeatureAvailability>, Constable

public enum FeatureAvailability
extends Enum<FeatureAvailability>

Which display-feature sources an AnnotatorSequence carries: the four reachable combinations of key features and verbose features.

This captures what a sequence has; it is distinct from the user-interface's notion of what is currently shown. Key features back the key-feature view and verbose features back the all-features view, so a sequence with NONE offers no feature views at all.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOTH	Both key and verbose display features are available.
KEY_ONLY	Only key display features are available.
NONE	Neither key nor verbose display features are available.
VERBOSE_ONLY	Only verbose display features are available.

Method Summary

Modifier and Type	Method	Description
boolean	keyAvailable()	Returns whether key display features are available, enabling the key-feature view.
static FeatureAvailability	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FeatureAvailability[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.
boolean	verboseAvailable()	Returns whether verbose display features are available, enabling the all-features view.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final FeatureAvailability NONE

Neither key nor verbose display features are available.

KEY_ONLY

public static final FeatureAvailability KEY_ONLY

Only key display features are available.

VERBOSE_ONLY

public static final FeatureAvailability VERBOSE_ONLY

Only verbose display features are available.

BOTH

public static final FeatureAvailability BOTH

Both key and verbose display features are available.

Method Details

values

public static FeatureAvailability[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static FeatureAvailability valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

keyAvailable

public boolean keyAvailable()

Returns whether key display features are available, enabling the key-feature view.

Returns:

true for KEY_ONLY and BOTH

verboseAvailable

public boolean verboseAvailable()

Returns whether verbose display features are available, enabling the all-features view.

Returns:

true for VERBOSE_ONLY and BOTH