TokenType (SnuggleTeX Core 1.5.0-SNAPSHOT API)

java.lang.Object
- java.lang.Enum<TokenType>
- - uk.ac.ed.ph.snuggletex.tokens.TokenType

All Implemented Interfaces:

Serializable, Comparable<TokenType>
```
public enum TokenType
extends Enum<TokenType>
```
Enumerates the various types of LaTeX tokens.
Developer Note
The less complex types of tokens are described as SimpleTokens here.

Version:

$Revision:179 $

Author:

David McKain

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ARGUMENT_CONTAINER`
`BRACE_CONTAINER`
`COMMAND`
`ENVIRONMENT`
`ERROR`
`LR_MODE_NEW_PARAGRAPH`
`MATH_CHARACTER`
`MATH_NUMBER`
`NEW_PARAGRAPH`
`ROOT` Main types, correspond to a subclass of `Token`
`TAB_CHARACTER`
`TEXT_MODE_TEXT`
`VERBATIM_MODE_TEXT`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static TokenType`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static 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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - ROOT
```
public static final TokenType ROOT
```
    Main types, correspond to a subclass of Token
  - ARGUMENT_CONTAINER
```
public static final TokenType ARGUMENT_CONTAINER
```
  - BRACE_CONTAINER
```
public static final TokenType BRACE_CONTAINER
```
  - ENVIRONMENT
```
public static final TokenType ENVIRONMENT
```
  - COMMAND
```
public static final TokenType COMMAND
```
  - ERROR
```
public static final TokenType ERROR
```
  - MATH_CHARACTER
```
public static final TokenType MATH_CHARACTER
```
  - NEW_PARAGRAPH
```
public static final TokenType NEW_PARAGRAPH
```
  - TAB_CHARACTER
```
public static final TokenType TAB_CHARACTER
```
  - TEXT_MODE_TEXT
```
public static final TokenType TEXT_MODE_TEXT
```
  - LR_MODE_NEW_PARAGRAPH
```
public static final TokenType LR_MODE_NEW_PARAGRAPH
```
  - VERBATIM_MODE_TEXT
```
public static final TokenType VERBATIM_MODE_TEXT
```
  - MATH_NUMBER
```
public static final TokenType MATH_NUMBER
```
- Method Detail
  - values
```
public static TokenType[] 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 (TokenType c : TokenType.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static 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

Enum TokenType

Developer Note

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

ROOT

ARGUMENT_CONTAINER

BRACE_CONTAINER

ENVIRONMENT

COMMAND

ERROR

MATH_CHARACTER

NEW_PARAGRAPH

TAB_CHARACTER

TEXT_MODE_TEXT

LR_MODE_NEW_PARAGRAPH

VERBATIM_MODE_TEXT

MATH_NUMBER

Method Detail

values

valueOf