Enum Class LayerKey.Scope

java.lang.Object

java.lang.Enum<LayerKey.Scope>

opennlp.tools.document.LayerKey.Scope

All Implemented Interfaces:

Serializable, Comparable<LayerKey.Scope>, Constable

Enclosing class:

LayerKey<T>

public static enum LayerKey.Scope
extends Enum<LayerKey.Scope>

How the annotations of a layer relate to the document text.

Since:

3.0.0

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DOCUMENT	The layer's values describe the document as a whole and carry no spans.
POSITIONAL	Every annotation of the layer is anchored to a span of the text.

Method Summary

Modifier and Type	Method	Description
static LayerKey.Scope	valueOf(String name)	Returns the enum constant of this class with the specified name.
static LayerKey.Scope[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

POSITIONAL

public static final LayerKey.Scope POSITIONAL

Every annotation of the layer is anchored to a span of the text.

DOCUMENT

public static final LayerKey.Scope DOCUMENT

The layer's values describe the document as a whole and carry no spans.

Method Details

values

public static LayerKey.Scope[] 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 LayerKey.Scope 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