org.docx4j.org.apache.xml.dtm

Class DTMException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.docx4j.org.apache.xml.dtm.DTMException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

DTMConfigurationException

public class DTMException
extends RuntimeException

This class specifies an exceptional condition that occured in the DTM module.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DTMException(String message) Create a new DTMException.
DTMException(String message, SourceLocator locator) Create a new DTMException from a message and a Locator.
DTMException(String message, SourceLocator locator, Throwable e) Wrap an existing exception in a DTMException.
DTMException(String message, Throwable e) Wrap an existing exception in a DTMException.
DTMException(Throwable e) Create a new DTMException wrapping an existing exception.

Method Summary

Modifier and Type	Method and Description
Throwable	getCause() Returns the cause of this throwable or null if the cause is nonexistent or unknown.
Throwable	getException() This method retrieves an exception that this exception wraps.
String	getLocationAsString() Get the location information as a string.
SourceLocator	getLocator() Method getLocator retrieves an instance of a SourceLocator object that specifies where an error occured.
String	getMessageAndLocation() Get the error message with location information appended.
Throwable	initCause(Throwable cause) Initializes the cause of this throwable to the specified value.
void	printStackTrace() Print the the trace of methods from where the error originated.
void	printStackTrace(PrintStream s) Print the the trace of methods from where the error originated.
void	printStackTrace(PrintWriter s) Print the the trace of methods from where the error originated.
void	setLocator(SourceLocator location) Method setLocator sets an instance of a SourceLocator object that specifies where an error occured.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DTMException

public DTMException(String message)

Create a new DTMException.

Parameters:

message - The error or warning message.

DTMException

public DTMException(Throwable e)

Create a new DTMException wrapping an existing exception.

Parameters:

e - The exception to be wrapped.

DTMException

public DTMException(String message,
                    Throwable e)

Wrap an existing exception in a DTMException.

This is used for throwing processor exceptions before the processing has started.

Parameters:

message - The error or warning message, or null to use the message from the embedded exception.

e - Any exception

DTMException

public DTMException(String message,
                    SourceLocator locator)

Create a new DTMException from a message and a Locator.

This constructor is especially useful when an application is creating its own exception from within a DocumentHandler callback.

Parameters:

message - The error or warning message.

locator - The locator object for the error or warning.

DTMException

public DTMException(String message,
                    SourceLocator locator,
                    Throwable e)

Wrap an existing exception in a DTMException.

Parameters:

message - The error or warning message, or null to use the message from the embedded exception.

locator - The locator object for the error or warning.

e - Any exception

Method Detail

getLocator

public SourceLocator getLocator()

Method getLocator retrieves an instance of a SourceLocator object that specifies where an error occured.

Returns:

A SourceLocator object, or null if none was specified.

setLocator

public void setLocator(SourceLocator location)

Method setLocator sets an instance of a SourceLocator object that specifies where an error occured.

Parameters:

location - A SourceLocator object, or null to clear the location.

getException

public Throwable getException()

This method retrieves an exception that this exception wraps.

Returns:

An Throwable object, or null.

See Also:

getCause()

getCause

public Throwable getCause()

Returns the cause of this throwable or null if the cause is nonexistent or unknown. (The cause is the throwable that caused this throwable to get thrown.)

Overrides:

getCause in class Throwable

initCause

public Throwable initCause(Throwable cause)

Initializes the cause of this throwable to the specified value. (The cause is the throwable that caused this throwable to get thrown.)

This method can be called at most once. It is generally called from within the constructor, or immediately after creating the throwable. If this throwable was created with DTMException(Throwable) or DTMException(String,Throwable), this method cannot be called even once.

Overrides:

initCause in class Throwable

Parameters:

cause - the cause (which is saved for later retrieval by the getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

Returns:

a reference to this Throwable instance.

Throws:

IllegalArgumentException - if cause is this throwable. (A throwable cannot be its own cause.)

IllegalStateException - if this throwable was created with DTMException(Throwable) or DTMException(String,Throwable), or this method has already been called on this throwable.

getMessageAndLocation

public String getMessageAndLocation()

Get the error message with location information appended.

getLocationAsString

public String getLocationAsString()

Get the location information as a string.

Returns:

A string with location info, or null if there is no location information.

printStackTrace

public void printStackTrace()

Print the the trace of methods from where the error originated. This will trace all nested exception objects, as well as this object.

Overrides:

printStackTrace in class Throwable

printStackTrace

public void printStackTrace(PrintStream s)

Print the the trace of methods from where the error originated. This will trace all nested exception objects, as well as this object.

Overrides:

printStackTrace in class Throwable

Parameters:

s - The stream where the dump will be sent to.

printStackTrace

public void printStackTrace(PrintWriter s)

Print the the trace of methods from where the error originated. This will trace all nested exception objects, as well as this object.

Overrides:

printStackTrace in class Throwable

Parameters:

s - The writer where the dump will be sent to.