uk.ac.ed.ph.snuggletex

Enum DOMOutputOptions.ErrorOutputOptions

java.lang.Object

java.lang.Enum<DOMOutputOptions.ErrorOutputOptions>

uk.ac.ed.ph.snuggletex.DOMOutputOptions.ErrorOutputOptions

All Implemented Interfaces:

Serializable, Comparable<DOMOutputOptions.ErrorOutputOptions>

Enclosing class:

DOMOutputOptions

public static enum DOMOutputOptions.ErrorOutputOptions
extends Enum<DOMOutputOptions.ErrorOutputOptions>

Enumerates the various options for representing InputErrors in the resulting DOM.

Enum Constant Summary

Enum Constants

Enum Constant and Description
NO_OUTPUT No error information is appended to the DOM.
XHTML Each error is marked up as an XHTML div element associated to the error CSS class.
XML_FULL Full error information is appended to the DOM as a text XML element containing the error code (as an attribute) plus full textual information of the error's location.
XML_SHORT Basic error information is appended to the DOM as an empty XML element containing just the error code.

Method Summary

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

NO_OUTPUT

public static final DOMOutputOptions.ErrorOutputOptions NO_OUTPUT

No error information is appended to the DOM. (Clients can still get at error information via SnuggleSession.getErrors().)

XML_SHORT

public static final DOMOutputOptions.ErrorOutputOptions XML_SHORT

Basic error information is appended to the DOM as an empty XML element containing just the error code.

XML_FULL

public static final DOMOutputOptions.ErrorOutputOptions XML_FULL

Full error information is appended to the DOM as a text XML element containing the error code (as an attribute) plus full textual information of the error's location.

XHTML

public static final DOMOutputOptions.ErrorOutputOptions XHTML

Each error is marked up as an XHTML div element associated to the error CSS class.

Errors occurring inside MathML expressions will be represented by a merror placeholder, with a full XHTML element appended immediately after the MathML.

Method Detail

values

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

Returns:

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

valueOf

public static DOMOutputOptions.ErrorOutputOptions 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