This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


javax.xml.transform
exception TransformerException

java.lang.Object extended by java.lang.Throwable extended by java.lang.Exception extended by javax.xml.transform.TransformerException
All Implemented Interfaces:
Serializable

public exception TransformerException
extends Exception

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


Constructor Summary

          Create a new TransformerException.

          Create a new TransformerException from a message and a Locator.

          Wrap an existing exception in a TransformerException.

          Wrap an existing exception in a TransformerException.

          Create a new TransformerException wrapping an existing exception.
 
Method Summary
 Throwable

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

          This method retrieves an exception that this exception wraps.
 String

          Get the location information as a string.
 SourceLocator

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

          Get the error message with location information appended.
 Throwable

          Initializes the cause of this throwable to the specified value.
 void

          Print the the trace of methods from where the error originated.
 void

          Print the the trace of methods from where the error originated.
 void

          Print the the trace of methods from where the error originated.
 void

          Method setLocator sets an instance of a SourceLocator object that specifies where an error occured.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TransformerException

public TransformerException(String message)
Create a new TransformerException.

Parameters:
message - The error or warning message.

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

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(Throwable e)
Create a new TransformerException wrapping an existing exception.

Parameters:
e - The exception to be wrapped.
Method Detail

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

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.

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

initCause

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 {@link #TransformerException(Throwable)} or {@link #TransformerException(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 {@link #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.

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.

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.


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.