Class TransformerException
- java.lang.Object
-
- 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 occurred during the transformation process.
- Since:
- 1.4
- See Also:
- Serialized Form
Constructor Summary
Constructor | Description |
---|---|
TransformerException(String message) | Create a new TransformerException. |
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. |
TransformerException(Throwable e) | Create a new TransformerException wrapping an existing exception. |
Method Summary
Modifier and Type | Method | Description |
---|---|---|
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(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 occurred. |
Methods declared in class java.lang.Throwable
addSuppressed, fillInStackTrace, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, setStackTrace, toString
Methods declared in class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
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 occurred.
- 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 occurred.
- 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.)
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)
, this method cannot be called even once.
- Overrides:
-
initCause
in classThrowable
- Parameters:
-
cause
- the cause (which is saved for later retrieval by thegetCause()
method). (Anull
value is permitted, and indicates that the cause is nonexistent or unknown.) - Returns:
- a reference to this
Throwable
instance. - Throws:
-
IllegalArgumentException
- ifcause
is this throwable. (A throwable cannot be its own cause.) -
IllegalStateException
- if this throwable was created withTransformerException(Throwable)
orTransformerException(String,Throwable)
, 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
in classThrowable
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 classThrowable
- 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 classThrowable
- Parameters:
-
s
- The writer where the dump will be sent to.