TransformerException (Java Platform SE 8 ) (original) (raw)

• 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.
See Also:
Serialized Form

• • Constructor Summary

  Constructors

  Constructor	Description
  TransformerException(String message)	Create a new 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(String message,Throwable e)	Wrap an existing exception in a TransformerException.
  TransformerException(Throwable e)	Create a new TransformerException wrapping an existing exception.

  • Method Summary

  All Methods Instance Methods Concrete Methods

  Modifier and Type	Method	Description
  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 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 inherited from class java.lang.[Throwable](../../../java/lang/Throwable.html "class in java.lang")  
     `[addSuppressed](../../../java/lang/Throwable.html#addSuppressed-java.lang.Throwable-), [fillInStackTrace](../../../java/lang/Throwable.html#fillInStackTrace--), [getLocalizedMessage](../../../java/lang/Throwable.html#getLocalizedMessage--), [getMessage](../../../java/lang/Throwable.html#getMessage--), [getStackTrace](../../../java/lang/Throwable.html#getStackTrace--), [getSuppressed](../../../java/lang/Throwable.html#getSuppressed--), [setStackTrace](../../../java/lang/Throwable.html#setStackTrace-java.lang.StackTraceElement:A-), [toString](../../../java/lang/Throwable.html#toString--)`  
     * ### Methods inherited from class java.lang.[Object](../../../java/lang/Object.html "class in java.lang")  
     `[clone](../../../java/lang/Object.html#clone--), [equals](../../../java/lang/Object.html#equals-java.lang.Object-), [finalize](../../../java/lang/Object.html#finalize--), [getClass](../../../java/lang/Object.html#getClass--), [hashCode](../../../java/lang/Object.html#hashCode--), [notify](../../../java/lang/Object.html#notify--), [notifyAll](../../../java/lang/Object.html#notifyAll--), [wait](../../../java/lang/Object.html#wait--), [wait](../../../java/lang/Object.html#wait-long-), [wait](../../../java/lang/Object.html#wait-long-int-)`

• • Constructor Detail

     * #### TransformerException  
     public TransformerException([String](../../../java/lang/String.html "class in java.lang") message)  
     Create a new TransformerException.  
     Parameters:  
     `message` \- The error or warning message.  
     * #### TransformerException  
     public TransformerException([Throwable](../../../java/lang/Throwable.html "class in java.lang") e)  
     Create a new TransformerException wrapping an existing exception.  
     Parameters:  
     `e` \- The exception to be wrapped.  
     * #### TransformerException  
     public TransformerException([String](../../../java/lang/String.html "class in java.lang") message,  
                                 [Throwable](../../../java/lang/Throwable.html "class in java.lang") 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](../../../java/lang/String.html "class in java.lang") message,  
                                 [SourceLocator](../../../javax/xml/transform/SourceLocator.html "interface in javax.xml.transform") 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](../../../java/lang/String.html "class in java.lang") message,  
                                 [SourceLocator](../../../javax/xml/transform/SourceLocator.html "interface in javax.xml.transform") locator,  
                                 [Throwable](../../../java/lang/Throwable.html "class in java.lang") 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](../../../javax/xml/transform/SourceLocator.html "interface in javax.xml.transform") 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](../../../javax/xml/transform/SourceLocator.html "interface in javax.xml.transform") 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](../../../java/lang/Throwable.html "class in java.lang") getException()  
    This method retrieves an exception that this exception wraps.  
    Returns:  
    An Throwable object, or null.  
    See Also:  
    [getCause()](../../../javax/xml/transform/TransformerException.html#getCause--)  
    * #### getCause  
    public [Throwable](../../../java/lang/Throwable.html "class in java.lang") 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--)` in class `[Throwable](../../../java/lang/Throwable.html "class in java.lang")`  
    Returns:  
    the cause, or null if unknown  
    * #### initCause  
    public [Throwable](../../../java/lang/Throwable.html "class in java.lang") initCause([Throwable](../../../java/lang/Throwable.html "class in java.lang") 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)](../../../javax/xml/transform/TransformerException.html#TransformerException-java.lang.Throwable-) or[TransformerException(String,Throwable)](../../../javax/xml/transform/TransformerException.html#TransformerException-java.lang.String-java.lang.Throwable-), this method cannot be called even once.  
    Overrides:  
    `[initCause](../../../java/lang/Throwable.html#initCause-java.lang.Throwable-)` in class `[Throwable](../../../java/lang/Throwable.html "class in java.lang")`  
    Parameters:  
    `cause` \- the cause (which is saved for later retrieval by the[getCause()](../../../javax/xml/transform/TransformerException.html#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](../../../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)](../../../javax/xml/transform/TransformerException.html#TransformerException-java.lang.Throwable-) or[TransformerException(String,Throwable)](../../../javax/xml/transform/TransformerException.html#TransformerException-java.lang.String-java.lang.Throwable-), or this method has already been called on this throwable.  
    * #### getMessageAndLocation  
    public [String](../../../java/lang/String.html "class in java.lang") getMessageAndLocation()  
    Get the error message with location information appended.  
    Returns:  
    A `String` representing the error message with location information appended.  
    * #### getLocationAsString  
    public [String](../../../java/lang/String.html "class in java.lang") 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--)` in class `[Throwable](../../../java/lang/Throwable.html "class in java.lang")`  
    * #### printStackTrace  
    public void printStackTrace([PrintStream](../../../java/io/PrintStream.html "class in java.io") 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-java.io.PrintStream-)` 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](../../../java/io/PrintWriter.html "class in java.io") 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-java.io.PrintWriter-)` 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 SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.