javax.xml.transform
Class TransformerException

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

public class TransformerException
extends Exception

An exception occurred during the transformation process.

See Also:
Serialized Form

Constructor Summary
TransformerException(String msg)
          Constructor with a detail message.
TransformerException(String msg, SourceLocator locator)
          Constructor with a detail message and locator.
TransformerException(String msg, SourceLocator locator, Throwable cause)
          Constructor with detail message, locator and underlying cause.
TransformerException(String msg, Throwable cause)
          Constructor with a detail message and underlying cause.
TransformerException(Throwable cause)
          Constructor with an underlying cause.
 
Method Summary
 Throwable getCause()
          Returns the underlying cause of this exception.
 Throwable getException()
          Returns the underlying cause of this exception.
 String getLocationAsString()
          Returns the location information as a string.
 SourceLocator getLocator()
          Returns a locator indicating where the error occurred.
 String getMessageAndLocation()
          Returns the exception message with location information appended.
 Throwable initCause(Throwable cause)
          Initializes the root cause of this exception.
 void printStackTrace()
          Print a stack trace to the standard error stream.
 void printStackTrace(PrintStream s)
          Print a stack trace to the specified PrintStream.
 void printStackTrace(PrintWriter s)
          Prints the exception, the detailed message and the stack trace associated with this Throwable to the given PrintWriter.
 void setLocator(SourceLocator location)
          Sets the locator indicating where the error occurred.
 
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
 

Constructor Detail

TransformerException

public TransformerException(String msg)
Constructor with a detail message.


TransformerException

public TransformerException(Throwable cause)
Constructor with an underlying cause.


TransformerException

public TransformerException(String msg,
                            Throwable cause)
Constructor with a detail message and underlying cause.


TransformerException

public TransformerException(String msg,
                            SourceLocator locator)
Constructor with a detail message and locator.


TransformerException

public TransformerException(String msg,
                            SourceLocator locator,
                            Throwable cause)
Constructor with detail message, locator and underlying cause.

Method Detail

getLocator

public SourceLocator getLocator()
Returns a locator indicating where the error occurred.


setLocator

public void setLocator(SourceLocator location)
Sets the locator indicating where the error occurred.


getException

public Throwable getException()
Returns the underlying cause of this exception.


getCause

public Throwable getCause()
Returns the underlying cause of this exception.

Overrides:
getCause in class Throwable
Returns:
the cause of this Throwable

initCause

public Throwable initCause(Throwable cause)
Initializes the root cause of this exception. This method may be called only once, and will be called by the constructor if a non-null cause is specified. Really phenomenally poor API design.

Overrides:
initCause in class Throwable
Parameters:
cause - the underlying cause
Returns:
this
Throws:
IllegalArgumentException - if this exception is passed as the argument
IllegalStateException - if a cause has already been initialized

getMessageAndLocation

public String getMessageAndLocation()
Returns the exception message with location information appended.


getLocationAsString

public String getLocationAsString()
Returns the location information as a string.


printStackTrace

public void printStackTrace()
Description copied from class: Throwable
Print a stack trace to the standard error stream. This stream is the current contents of System.err. The first line of output is the result of Throwable.toString(), and the remaining lines represent the data created by Throwable.fillInStackTrace(). While the format is unspecified, this implementation uses the suggested format, demonstrated by this example:
 public class Junk
 {
   public static void main(String args[])
   {
     try
       {
         a();
       }
     catch(HighLevelException e)
       {
         e.printStackTrace();
       }
   }
   static void a() throws HighLevelException
   {
     try
       {
         b();
       }
     catch(MidLevelException e)
       {
         throw new HighLevelException(e);
       }
   }
   static void b() throws MidLevelException
   {
     c();
   }
   static void c() throws MidLevelException
   {
     try
       {
         d();
       }
     catch(LowLevelException e)
       {
         throw new MidLevelException(e);
       }
   }
   static void d() throws LowLevelException
   {
     e();
   }
   static void e() throws LowLevelException
   {
     throw new LowLevelException();
   }
 }
 class HighLevelException extends Exception
 {
   HighLevelException(Throwable cause) { super(cause); }
 }
 class MidLevelException extends Exception
 {
   MidLevelException(Throwable cause)  { super(cause); }
 }
 class LowLevelException extends Exception
 {
 }
 

  HighLevelException: MidLevelException: LowLevelException
          at Junk.a(Junk.java:13)
          at Junk.main(Junk.java:4)
  Caused by: MidLevelException: LowLevelException
          at Junk.c(Junk.java:23)
          at Junk.b(Junk.java:17)
          at Junk.a(Junk.java:11)
          ... 1 more
  Caused by: LowLevelException
          at Junk.e(Junk.java:30)
          at Junk.d(Junk.java:27)
          at Junk.c(Junk.java:21)
          ... 3 more
 

Overrides:
printStackTrace in class Throwable

printStackTrace

public void printStackTrace(PrintStream s)
Description copied from class: Throwable
Print a stack trace to the specified PrintStream. See Throwable.printStackTrace() for the sample format.

Overrides:
printStackTrace in class Throwable
Parameters:
s - the PrintStream to write the trace to

printStackTrace

public void printStackTrace(PrintWriter s)
Description copied from class: Throwable
Prints the exception, the detailed message and the stack trace associated with this Throwable to the given PrintWriter. The actual output written is implemention specific. Use the result of getStackTrace() when more precise information is needed.

This implementation first prints a line with the result of this object's toString() method.
Then for all elements given by getStackTrace it prints a line containing three spaces, the string "at " and the result of calling the toString() method on the StackTraceElement object. If getStackTrace() returns an empty array it prints a line containing three spaces and the string "<<No stacktrace available>>".
Then if getCause() doesn't return null it adds a line starting with "Caused by: " and the result of calling toString() on the cause.
Then for every cause (of a cause, etc) the stacktrace is printed the same as for the top level Throwable except that as soon as all the remaining stack frames of the cause are the same as the the last stack frames of the throwable that the cause is wrapped in then a line starting with three spaces and the string "... X more" is printed, where X is the number of remaining stackframes.

Overrides:
printStackTrace in class Throwable
Parameters:
s - the PrintWriter to write the trace to