Enum Class Document.DuplicateLayerPolicy

java.lang.Object

java.lang.Enum<Document.DuplicateLayerPolicy>

opennlp.tools.document.Document.DuplicateLayerPolicy

All Implemented Interfaces:

Serializable, Comparable<Document.DuplicateLayerPolicy>, Constable

Enclosing interface:

Document

public static enum Document.DuplicateLayerPolicy
extends Enum<Document.DuplicateLayerPolicy>

How Document.merge(Document, DuplicateLayerPolicy) treats a layer key that is present on both documents.

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
KEEP_EQUAL	Keep one copy of a layer key present on both documents when the two layers are structurally equal, for example when two parallel branches ran the same tokenizer.
REJECT	Reject any layer key present on both documents.

Method Summary

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

REJECT

public static final Document.DuplicateLayerPolicy REJECT

Reject any layer key present on both documents.

KEEP_EQUAL

public static final Document.DuplicateLayerPolicy KEEP_EQUAL

Keep one copy of a layer key present on both documents when the two layers are structurally equal, for example when two parallel branches ran the same tokenizer. Layers whose contents differ are rejected as with REJECT. Equality is Annotation equality: spans compare by offsets and type, never by probability, and values by their own equals.

Method Details

values

public static Document.DuplicateLayerPolicy[] 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 Document.DuplicateLayerPolicy 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