com.revolsys.io.xml

Class XmlProcessorError

java.lang.Object

com.revolsys.io.xml.XmlProcessorError

public class XmlProcessorError
extends Object

The XmlProcessorError class is used to record the information about an error in processing an XML document by the XmlProcessor class.

Author:

Paul Austin

Constructor Summary

Constructors

Constructor and Description
XmlProcessorError(String message, Object relatedInformation, Location location) Construct a new XmlProcessorError.

Method Summary

Methods

Modifier and Type	Method and Description
Throwable	getException() Get the exception that caused the error.
Location	getLocation() Get the location of the error.
String	getMessage() Get the error message.
Object	getRelatedInformation() Get additional information about the error.
String	toString() Get the string representation of the error.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlProcessorError

public XmlProcessorError(String message,
                 Object relatedInformation,
                 Location location)

Construct a new XmlProcessorError.

Parameters:

message - The error message.

relatedInformation - Additional information about the error.

location - The location of the error.

Method Detail

getException

public final Throwable getException()

Get the exception that caused the error. This method will return the relatedInformation if it is an instance of Throwable.

Returns:

The exception that caused the error.

getLocation

public final Location getLocation()

Get the location of the error.

Returns:

The location of the error.

getMessage

public final String getMessage()

Get the error message.

Returns:

The error message.

getRelatedInformation

public final Object getRelatedInformation()

Get additional information about the error.

Returns:

Additional information about the error.

toString

public String toString()

Get the string representation of the error.

Overrides:

toString in class Object

Returns:

The string representation of the error.