TransformerException (Java 2 Platform SE 5.0) (original) (raw)

javax.xml.transform

Class TransformerException

java.lang.Object extended by java.lang.Throwable java.lang.Exception javax.xml.transform.TransformerException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

TransformerConfigurationException

public class TransformerException

extends Exception

This class specifies an exceptional condition that occured during the transformation process.

See Also:

Serialized Form

Constructor Summary
TransformerException(String message) Create a new TransformerException.
[TransformerException](../../../javax/xml/transform/TransformerException.html#TransformerException%28java.lang.String, javax.xml.transform.SourceLocator%29)(String message,SourceLocator locator) Create a new TransformerException from a message and a Locator.
[TransformerException](../../../javax/xml/transform/TransformerException.html#TransformerException%28java.lang.String, javax.xml.transform.SourceLocator, java.lang.Throwable%29)(String message,SourceLocator locator,Throwable e) Wrap an existing exception in a TransformerException.
[TransformerException](../../../javax/xml/transform/TransformerException.html#TransformerException%28java.lang.String, java.lang.Throwable%29)(String message,Throwable e) Wrap an existing exception in a TransformerException.
TransformerException(Throwable e) Create a new TransformerException 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(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
fillInStackTrace, getLocalizedMessage, getMessage, getStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, [wait](../../../java/lang/Object.html#wait%28long, int%29)

Constructor Detail

TransformerException

public TransformerException(String message)

Create a new TransformerException.

Parameters:

message - The error or warning message.

TransformerException

public TransformerException(Throwable e)

Create a new TransformerException wrapping an existing exception.

Parameters:

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

e - 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 - The error or warning message.

locator - 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 - 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](../../../java/lang/Throwable.html#getCause%28%29) in class [Throwable](../../../java/lang/Throwable.html "class in java.lang")

Returns:

the cause of this throwable or null if the cause is nonexistent or unknown.

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(Throwable) or[TransformerException(String,Throwable)](../../../javax/xml/transform/TransformerException.html#TransformerException%28java.lang.String, java.lang.Throwable%29), this method cannot be called even once.

Overrides:

[initCause](../../../java/lang/Throwable.html#initCause%28java.lang.Throwable%29) in class [Throwable](../../../java/lang/Throwable.html "class in java.lang")

Parameters:

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

Returns:

a reference to this Throwable instance.

Throws:

[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang") - if cause is this throwable. (A throwable cannot be its own cause.)

[IllegalStateException](../../../java/lang/IllegalStateException.html "class in java.lang") - if this throwable was created with TransformerException(Throwable) or[TransformerException(String,Throwable)](../../../javax/xml/transform/TransformerException.html#TransformerException%28java.lang.String, java.lang.Throwable%29), or this method has already been called on this throwable.

getMessageAndLocation

public String getMessageAndLocation()

Get the error message with location information appended.

Returns:

A String representing 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](../../../java/lang/Throwable.html#printStackTrace%28%29) in class [Throwable](../../../java/lang/Throwable.html "class in java.lang")

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](../../../java/lang/Throwable.html#printStackTrace%28java.io.PrintStream%29) in class [Throwable](../../../java/lang/Throwable.html "class in java.lang")

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](../../../java/lang/Throwable.html#printStackTrace%28java.io.PrintWriter%29) in class [Throwable](../../../java/lang/Throwable.html "class in java.lang")

Parameters:

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

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.