uk.ac.ed.ph.snuggletex.definitions

Enum CommandType

java.lang.Object

java.lang.Enum<CommandType>

uk.ac.ed.ph.snuggletex.definitions.CommandType

All Implemented Interfaces:

Serializable, Comparable<CommandType>

public enum CommandType
extends Enum<CommandType>

Enumerates different types of LaTeX commands.

Version:

$Revision:179 $

Author:

David McKain

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMBINER Takes no arguments, absorbs the following token
COMPLEX Takes arguments
SIMPLE Takes no arguments

Method Summary

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

SIMPLE

public static final CommandType SIMPLE

Takes no arguments

COMBINER

public static final CommandType COMBINER

Takes no arguments, absorbs the following token

COMPLEX

public static final CommandType COMPLEX

Takes arguments

Method Detail

values

public static CommandType[] 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 (CommandType c : CommandType.values())
    System.out.println(c);

Returns:

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

valueOf

public static CommandType 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