org.jdom
Class JDOMException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--org.jdom.JDOMException
Direct Known Subclasses:
DataConversionException

public class JDOMException
extends Exception

JDOMException

This Exception subclass is the top level Exception that JDOM classes can throw. It's subclasses add specificity to the problems that can occur using JDOM, but this single Exception can be caught to handle all JDOM specific problems.

Author:
Brett McLaughlin, Jason Hunter
Version: 1.0

Constructor Summary
JDOMException()
           This will create an Exception.
JDOMException(String message)
           This will create an Exception with the given message.
JDOMException(String message, Throwable rootCause)
           This will create an Exception with the given message and wrap another Exception.

Method Summary
 StringgetMessage()
           This returns the message for the Exception.
 ThrowablegetRootCause()
           This will return the root cause Throwable, or null if one does not exist.
 voidprintStackTrace()
           This prints the stack trace of the Exception.
 voidprintStackTrace(PrintStream s)
           This prints the stack trace of the Exception to the given PrintStream.
 voidprintStackTrace(PrintWriter w)
           This prints the stack trace of the Exception to the given PrintWriter.

Methods inherited from class java.lang.Throwable
getLocalizedMessage, toString, fillInStackTrace

Methods inherited from class java.lang.Object
getClass, hashCode, equals, notify, notifyAll, wait, wait, wait

Constructor Detail

JDOMException

public JDOMException()

This will create an Exception.


JDOMException

public JDOMException(String message)

This will create an Exception with the given message.

Parameters:
message - String message indicating the problem that occurred.

JDOMException

public JDOMException(String message, Throwable rootCause)

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.

Parameters:
message - String message indicating the problem that occurred.
exception - Exception that caused this to be thrown.
Method Detail

getMessage

public String getMessage()

This returns the message for the Exception. If there is a root cause, the message associated with the root Exception is appended.

Returns: String - message for Exception.

getRootCause

public Throwable getRootCause()

This will return the root cause Throwable, or null if one does not exist.

Returns: Throwable - the wrapped Throwable.

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(PrintStream s)

This 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(PrintWriter w)

This 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.

Association Links

to Class java.lang.Throwable

A wrapped Throwable