org.apache.xml.dtm

Class DTMException

Known Direct Subclasses:
DTMConfigurationException

public class DTMException
extends RuntimeException

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

Constructor Summary

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

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(java.io.PrintStream s)
Print the the trace of methods from where the error originated.
void
printStackTrace(java.io.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.

Constructor Details

DTMException

public DTMException(String message)
Create a new DTMException.
Parameters:
message - The error or warning message.

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

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(Throwable e)
Create a new DTMException wrapping an existing exception.
Parameters:
e - The exception to be wrapped.

Method Details

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.)

getException

public Throwable getException()
This method retrieves an exception that this exception wraps.
Returns:
An Throwable object, or null.

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.

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.

getMessageAndLocation

public String getMessageAndLocation()
Get the error message with location information appended.

initCause

public Throwable initCause(Throwable cause)
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.

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.

printStackTrace

public void printStackTrace(java.io.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.
Parameters:
s - The stream where the dump will be sent to.

printStackTrace

public void printStackTrace(java.io.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.
Parameters:
s - The writer where the dump will be sent to.

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.

Copyright B) 2005 Apache XML Project. All Rights Reserved.