Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.jdom
Class JDOMException  view JDOMException download JDOMException.java

java.lang.Object
  extended byjava.lang.Throwable
      extended byjava.lang.Exception
          extended byorg.jdom.JDOMException
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
DataConversionException

public class JDOMException
extends java.lang.Exception

The top level exception that JDOM classes can throw. Its subclasses add specificity to the problems that can occur using JDOM. This single exception can be caught to handle all JDOM specific problems (some methods may throw java.io.IOException and such).

Version:
$Revision: 1.23 $, $Date: 2004/02/27 11:32:57 $

Nested Class Summary
 
Nested classes inherited from class java.lang.Throwable
 
Field Summary
private  java.lang.Throwable cause
          A wrapped Throwable
private static java.lang.String CVS_ID
           
 
Fields inherited from class java.lang.Exception
 
Fields inherited from class java.lang.Throwable
 
Constructor Summary
JDOMException()
          This will create an Exception.
JDOMException(java.lang.String message)
          This will create an Exception with the given message.
JDOMException(java.lang.String message, java.lang.Throwable cause)
          This will create an Exception with the given message and wrap another Exception.
 
Method Summary
 java.lang.Throwable getCause()
          This will return the root cause Throwable, or null if one does not exist.
 java.lang.String getMessage()
          This returns the message for the Exception.
private static java.lang.Throwable getNestedException(java.lang.Throwable parent)
           
private static java.lang.Throwable getNestedException(java.lang.Throwable parent, java.lang.String className, java.lang.String methodName)
           
 java.lang.Throwable initCause(java.lang.Throwable cause)
          Intializes the cause of this exception to be the specified value.
 void printStackTrace()
          This prints the stack trace of the Exception.
 void printStackTrace(java.io.PrintStream s)
          Prints the stack trace of the Exception to the given PrintStream.
 void printStackTrace(java.io.PrintWriter w)
          Prints the stack trace of the Exception to the given PrintWriter.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getLocalizedMessage, getStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CVS_ID

private static final java.lang.String CVS_ID
See Also:
Constant Field Values

cause

private java.lang.Throwable cause
A wrapped Throwable

Constructor Detail

JDOMException

public JDOMException()
This will create an Exception.


JDOMException

public JDOMException(java.lang.String message)
This will create an Exception with the given message.


JDOMException

public JDOMException(java.lang.String message,
                     java.lang.Throwable cause)
This will create an Exception with the given message and wrap another Exception. This is useful when the originating Exception should be held on to.

Method Detail

initCause

public java.lang.Throwable initCause(java.lang.Throwable cause)
Intializes the cause of this exception to be the specified value.


getMessage

public java.lang.String getMessage()
This returns the message for the Exception. If there are one or more nested exceptions, their messages are appended.


printStackTrace

public void printStackTrace()
This prints the stack trace of the Exception. If there is a root cause, the stack trace of the root Exception is printed right after.


printStackTrace

public void printStackTrace(java.io.PrintStream s)
Prints the stack trace of the Exception to the given PrintStream. If there is a root cause, the stack trace of the root Exception is printed right after.


printStackTrace

public void printStackTrace(java.io.PrintWriter w)
Prints the stack trace of the Exception to the given PrintWriter. If there is a root cause, the stack trace of the root Exception is printed right after.


getCause

public java.lang.Throwable getCause()
This will return the root cause Throwable, or null if one does not exist.


getNestedException

private static java.lang.Throwable getNestedException(java.lang.Throwable parent)

getNestedException

private static java.lang.Throwable getNestedException(java.lang.Throwable parent,
                                                      java.lang.String className,
                                                      java.lang.String methodName)