TransformerException
public
class
TransformerException
extends Exception
java.lang.Object | |||
↳ | java.lang.Throwable | ||
↳ | java.lang.Exception | ||
↳ | javax.xml.transform.TransformerException |
This class specifies an exceptional condition that occurred during the transformation process.
Summary
Public constructors | |
---|---|
TransformerException(String message)
Create a new TransformerException. |
|
TransformerException(Throwable e)
Create a new TransformerException wrapping an existing exception. |
|
TransformerException(String message, Throwable e)
Wrap an existing exception in a TransformerException. |
|
TransformerException(String message, SourceLocator locator)
Create a new TransformerException from a message and a Locator. |
|
TransformerException(String message, SourceLocator locator, Throwable e)
Wrap an existing exception in a TransformerException. |
Public methods | |
---|---|
Throwable
|
getCause()
Returns the cause of this throwable or |
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 occurred. |
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(PrintWriter s)
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
|
setLocator(SourceLocator location)
Method setLocator sets an instance of a SourceLocator object that specifies where an error occurred. |
Inherited methods | |
---|---|
Public constructors
TransformerException
public TransformerException (String message)
Create a new TransformerException.
Parameters | |
---|---|
message |
String : The error or warning message. |
TransformerException
public TransformerException (Throwable e)
Create a new TransformerException wrapping an existing exception.
Parameters | |
---|---|
e |
Throwable : The exception to be wrapped. |
TransformerException
public TransformerException (String message, Throwable e)
Wrap an existing exception in a TransformerException.
This is used for throwing processor exceptions before the processing has started.
Parameters | |
---|---|
message |
String : The error or warning message, or null to
use the message from the embedded exception. |
e |
Throwable : Any exception |
TransformerException
public TransformerException (String message, SourceLocator locator)
Create a new TransformerException 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 |
String : The error or warning message. |
locator |
SourceLocator : The locator object for the error or warning. |
TransformerException
public TransformerException (String message, SourceLocator locator, Throwable e)
Wrap an existing exception in a TransformerException.
Parameters | |
---|---|
message |
String : The error or warning message, or null to
use the message from the embedded exception. |
locator |
SourceLocator : The locator object for the error or warning. |
e |
Throwable : Any exception |
Public methods
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.)
Returns | |
---|---|
Throwable |
the cause of this throwable or null if the
cause is nonexistent or unknown. |
getException
public Throwable getException ()
This method retrieves an exception that this exception wraps.
Returns | |
---|---|
Throwable |
An Throwable object, or null. |
See also:
getLocationAsString
public String getLocationAsString ()
Get the location information as a string.
Returns | |
---|---|
String |
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 occurred.
Returns | |
---|---|
SourceLocator |
A SourceLocator object, or null if none was specified. |
getMessageAndLocation
public String getMessageAndLocation ()
Get the error message with location information appended.
Returns | |
---|---|
String |
A String representing the error message with
location information appended. |
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 TransformerException(java.lang.Throwable)
or
TransformerException(java.lang.String, java.lang.Throwable)
, this method cannot be called
even once.
Parameters | |
---|---|
cause |
Throwable : 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 | |
---|---|
Throwable |
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 TransformerException(java.lang.Throwable) or
TransformerException(java.lang.String, java.lang.Throwable) , or this method has already
been called on this throwable. |
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 (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 |
PrintWriter : The writer where the dump will be sent to. |
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.
Parameters | |
---|---|
s |
PrintStream : The stream 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 occurred.
Parameters | |
---|---|
location |
SourceLocator : A SourceLocator object, or null to clear the location. |