uk.ac.ed.ph.snuggletex.definitions

Enum LaTeXMode

java.lang.Object

java.lang.Enum<LaTeXMode>

uk.ac.ed.ph.snuggletex.definitions.LaTeXMode

All Implemented Interfaces:

Serializable, Comparable<LaTeXMode>

public enum LaTeXMode
extends Enum<LaTeXMode>

Enumerates the various modes of LaTeX input.

Version:

$Revision$

Author:

David McKain

Enum Constant Summary

Enum Constants

Enum Constant and Description
LR LaTeX LR (left-to-right) Mode, used in things like \\mbox and friends
MATH LaTeX MATH Mode, entered from PARAGRAPH or LR mode via commands such as \[ or by certain explicit MATH environments.
PARAGRAPH The default LaTeX PARAGRAPH Mode, representing free-flowing textual content.
VERBATIM LaTeX VERBATIM Mode, which pulls in all content until a mandatory LaTeXTokeniser.Terminator is found.

Method Summary

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

PARAGRAPH

public static final LaTeXMode PARAGRAPH

The default LaTeX PARAGRAPH Mode, representing free-flowing textual content. Parsing always starts in this mode.

LR

public static final LaTeXMode LR

LaTeX LR (left-to-right) Mode, used in things like \\mbox and friends

MATH

public static final LaTeXMode MATH

LaTeX MATH Mode, entered from PARAGRAPH or LR mode via commands such as \[ or by certain explicit MATH environments.

VERBATIM

public static final LaTeXMode VERBATIM

LaTeX VERBATIM Mode, which pulls in all content until a mandatory LaTeXTokeniser.Terminator is found.

Method Detail

values

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

Returns:

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

valueOf

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