public class

TransformerException

extends Exception
java.lang.Object
   ↳ java.lang.Throwable
     ↳ java.lang.Exception
       ↳ javax.xml.transform.TransformerException
Known Direct Subclasses

Class Overview

This class specifies an exceptional condition that occured 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 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.
synchronized Throwable initCause(Throwable cause)
Initializes the cause of this throwable to the specified value.
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 printStackTrace()
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.
[Expand]
Inherited Methods
From class java.lang.Throwable
From class java.lang.Object

Public Constructors

public TransformerException (String message)

Create a new TransformerException.

Parameters
message The error or warning message.

public TransformerException (Throwable e)

Create a new TransformerException wrapping an existing exception.

Parameters
e The exception to be wrapped.

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 The error or warning message, or null to use the message from the embedded exception.
e Any exception

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 The error or warning message.
locator The locator object for the error or warning.

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

Wrap an existing exception in a TransformerException.

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

Public Methods

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

public Throwable getException ()

This method retrieves an exception that this exception wraps.

Returns
  • An Throwable object, or null.
See Also

public String getLocationAsString ()

Get the location information as a string.

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

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.

public String getMessageAndLocation ()

Get the error message with location information appended.

Returns
  • A String representing the error message with location information appended.

public synchronized 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(Throwable) or TransformerException(String, Throwable), this method cannot be called even once.

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 TransformerException(Throwable) or TransformerException(String, Throwable), or this method has already been called on this throwable.

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 The writer where the dump will be sent to.

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 The stream where the dump will be sent to.

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.

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.