SnuggleTeX 1.3.0 · uk.ac.ed.ph.snuggletex.InputError

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.

Field Summary

Modifier and Type	Field and Description
private final Object[]	arguments Any additional arguments about the error.
private final ErrorCode	errorCode Error code
private final FrozenSlice	slice Slice the error occurred in. This may be null in certain circumstances
private String	stringRepresentation

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

Modifier and Type	Method and Description
private String	buildStringRepresentation()
public Object[]	getArguments() Returns any additional arguments providing information about the error.
public ErrorCode	getErrorCode() Returns the `ErrorCode` for this error.
public FrozenSlice	getSlice() Returns the `FrozenSlice` indicating where the error occurred in the original `SnuggleInput`.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

arguments	back to summary
private final Object[] arguments Any additional arguments about the error. These are passed to `MessageFormatter` when formatting errors in a readable form.

errorCode	back to summary
private final ErrorCode errorCode Error code

slice	back to summary
private final FrozenSlice slice Slice the error occurred in. This may be null in certain circumstances

stringRepresentation	back to summary
private String stringRepresentation

InputError	back to summary
public InputError(final ErrorCode errorCode, final FrozenSlice slice, final Object... arguments)

buildStringRepresentation	back to summary
private String buildStringRepresentation()

getArguments	back to summary
public Object[] getArguments() Returns any additional arguments providing information about the error.

getErrorCode	back to summary
public ErrorCode getErrorCode() Returns the `ErrorCode` for this error.

getSlice	back to summary
public FrozenSlice getSlice() Returns the `FrozenSlice` indicating where the error occurred in the original `SnuggleInput`.

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Annotations @Override

public String toString()

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations