Package de.jplag

Enum Class SharedTokenType

java.lang.Object

java.lang.Enum<SharedTokenType>

de.jplag.SharedTokenType

All Implemented Interfaces:

TokenType, Serializable, Comparable<SharedTokenType>, Constable

public enum SharedTokenType
extends Enum<SharedTokenType>
implements TokenType

Shared token types that occur for any language.

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
FILE_END	Marks the end of the file.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Returns the user-readable description of this token type.
Boolean	isExcludedFromMatching()	Indicates that no matches containing this token type shall be generated.
static SharedTokenType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SharedTokenType[]	values()	Returns an array containing the constants of this enum class, 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

FILE_END

public static final SharedTokenType FILE_END

Marks the end of the file. Every parsed file must have this token type as its last element.

Method Details

values

public static SharedTokenType[] 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 SharedTokenType 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

getDescription

public String getDescription()

Description copied from interface: TokenType

Returns the user-readable description of this token type.

Specified by:

getDescription in interface TokenType

isExcludedFromMatching

public Boolean isExcludedFromMatching()

Description copied from interface: TokenType

Indicates that no matches containing this token type shall be generated. Defaults to false.

Specified by:

isExcludedFromMatching in interface TokenType

Returns:

true if token type is excluded from matching, otherwise false.