uk.ac.ed.ph.snuggletex.internal

Enum LaTeXTokeniser.TokenisationMode

java.lang.Object

java.lang.Enum<LaTeXTokeniser.TokenisationMode>

uk.ac.ed.ph.snuggletex.internal.LaTeXTokeniser.TokenisationMode

All Implemented Interfaces:

Serializable, Comparable<LaTeXTokeniser.TokenisationMode>

Enclosing class:

LaTeXTokeniser

public static enum LaTeXTokeniser.TokenisationMode
extends Enum<LaTeXTokeniser.TokenisationMode>

Enumeration of the various "tokenisation modes" we will be running in. This is only really used for documentation during debugging!

Enum Constant Summary

Enum Constants

Enum Constant and Description
BRACE
BUILTIN_COMMAND_ARGUMENT
BUILTIN_ENVIRONMENT_CONTENT
MATH
TOP_LEVEL

Method Summary

Modifier and Type	Method and Description
static LaTeXTokeniser.TokenisationMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static LaTeXTokeniser.TokenisationMode[]	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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TOP_LEVEL

public static final LaTeXTokeniser.TokenisationMode TOP_LEVEL

BRACE

public static final LaTeXTokeniser.TokenisationMode BRACE

MATH

public static final LaTeXTokeniser.TokenisationMode MATH

BUILTIN_COMMAND_ARGUMENT

public static final LaTeXTokeniser.TokenisationMode BUILTIN_COMMAND_ARGUMENT

BUILTIN_ENVIRONMENT_CONTENT

public static final LaTeXTokeniser.TokenisationMode BUILTIN_ENVIRONMENT_CONTENT

Method Detail

values

public static LaTeXTokeniser.TokenisationMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (LaTeXTokeniser.TokenisationMode c : LaTeXTokeniser.TokenisationMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static LaTeXTokeniser.TokenisationMode 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