uk.ac.ed.ph.snuggletex

Class InputError

java.lang.Object

uk.ac.ed.ph.snuggletex.InputError

public final class InputError
extends Object

Encapsulates an error in the LaTeX input, providing information about what the error is and where it occurred.

See the MessageFormatter for methods formatting instances of this class in various ways.

Version:

$Revision$

Author:

David McKain

Constructor Summary

Constructors

Constructor and Description
InputError(ErrorCode errorCode, FrozenSlice slice, Object... arguments)

Method Summary

Modifier and Type	Method and Description
Object[]	getArguments() Returns any additional arguments providing information about the error.
ErrorCode	getErrorCode() Returns the ErrorCode for this error.
FrozenSlice	getSlice() Returns the FrozenSlice indicating where the error occurred in the original SnuggleInput.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

InputError

public InputError(ErrorCode errorCode,
                  FrozenSlice slice,
                  Object... arguments)

Method Detail

getErrorCode

public ErrorCode getErrorCode()

Returns the ErrorCode for this error.

getSlice

public FrozenSlice getSlice()

Returns the FrozenSlice indicating where the error occurred in the original SnuggleInput.

getArguments

public Object[] getArguments()

Returns any additional arguments providing information about the error.

toString

public String toString()

Overrides:

toString in class Object