Enum Token.TokenType

java.lang.Object

java.lang.Enum<Token.TokenType>

org.tribuo.util.tokens.Token.TokenType

All Implemented Interfaces:

Serializable, Comparable<Token.TokenType>, java.lang.constant.Constable

Enclosing class:

Token

public static enum Token.TokenType
extends Enum<Token.TokenType>

Tokenizers may product multiple kinds of tokens, depending on the application to which they're being put. For example, when processing a document for highlighting during querying, we need to send through whitespace and punctuation so that the document looks as it did in it's original form. For most tokenizer applications, they will only send word tokens.

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
NGRAM
PUNCTUATION
WHITESPACE
WORD

Method Summary

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

WORD

public static final Token.TokenType WORD

NGRAM

public static final Token.TokenType NGRAM

PUNCTUATION

public static final Token.TokenType PUNCTUATION

WHITESPACE

public static final Token.TokenType WHITESPACE

Method Details

values

public static Token.TokenType[] values()

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

Returns:

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

valueOf

public static Token.TokenType valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null