uk.ac.ed.ph.snuggletex.definitions

Enum CoreErrorGroup

java.lang.Object

java.lang.Enum<CoreErrorGroup>

uk.ac.ed.ph.snuggletex.definitions.CoreErrorGroup

All Implemented Interfaces:

Serializable, Comparable<CoreErrorGroup>, ErrorGroup

public enum CoreErrorGroup
extends Enum<CoreErrorGroup>
implements ErrorGroup

Defines the groupings for the various types of client-induced errors that can arise when using the functionality provided by the core SnuggleTeX module.

Since:

1.2.0

Version:

$Revision:179 $

Author:

David McKain

Enum Constant Summary

Enum Constants

Enum Constant and Description
TDE
TFE
TTE

Method Summary

Modifier and Type	Method and Description
String	getName() Short name for this group, used as a key when formatting error messages via SnugglePackage.getErrorMessageBundle()
SnugglePackage	getPackage() SnugglePackage defining this group
static CoreErrorGroup	valueOf(String name) Returns the enum constant of this type with the specified name.
static CoreErrorGroup[]	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

TTE

public static final CoreErrorGroup TTE

TFE

public static final CoreErrorGroup TFE

TDE

public static final CoreErrorGroup TDE

Method Detail

values

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

Returns:

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

valueOf

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

getName

public String getName()

Description copied from interface: ErrorGroup

Short name for this group, used as a key when formatting error messages via SnugglePackage.getErrorMessageBundle()

Specified by:

getName in interface ErrorGroup

getPackage

public SnugglePackage getPackage()

Description copied from interface: ErrorGroup

SnugglePackage defining this group

Specified by:

getPackage in interface ErrorGroup