Top Description Fields Constructors Methods
uk.ac.ed.ph.snuggletex.upconversion

public final Class UpConversionFailure

extends Object
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable
Imports
uk.ac.ed.ph.snuggletex.ErrorCode, .InputError, java.io.Serializable, java.util.Arrays

This is the equivalent of an InputError for the up-conversion process, indicating that a particular island of Presentation MathML created by SnuggleTeX could not be up-converted to either Content MathML or Maxima input form. This will be due to one of the following reasons: See UpConversionUtilities for methods to help with this, including a method for converting these into error message Strings.
Author
David McKain
Since
1.1.0
Version
$Revision$
See Also
UpConversionUtilities

Field Summary

Modifier and TypeField and Description
private final Object[]
arguments

Any additional arguments about the error.

private final String
context

Context within the MathML that the error occurred, as a serialized DOM subtree

private final ErrorCode
errorCode

Error code

private static final long
private final String
xPath

XPath String corresponding to the first error Element.

Constructor Summary

AccessConstructor and Description
public
UpConversionFailure(final ErrorCode errorCode, final String xPath, final String context, final Object[] arguments)

Method Summary

Modifier and TypeMethod and Description
public Object[]
public String
public ErrorCode
public String
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

argumentsback to summary
private final Object[] arguments

Any additional arguments about the error. These are interpolated into error messages

contextback to summary
private final String context

Context within the MathML that the error occurred, as a serialized DOM subtree

errorCodeback to summary
private final ErrorCode errorCode

Error code

serialVersionUIDback to summary
private static final long serialVersionUID
xPathback to summary
private final String xPath

XPath String corresponding to the first error Element. This is given relative to the "top" of the original MathML (normally a <math/> Element but might be a <semantics/> or <annotation-xml/> and assumes that MathML namespace is the default.)

Since
1.2.0

Constructor Detail

UpConversionFailureback to summary
public UpConversionFailure(final ErrorCode errorCode, final String xPath, final String context, final Object[] arguments)

Method Detail

getArgumentsback to summary
public Object[] getArguments()
getContextback to summary
public String getContext()
getErrorCodeback to summary
public ErrorCode getErrorCode()
getXPathback to summary
public String getXPath()
toStringback 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