org.jdom

Class JDOMException

public class JDOMException extends 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.26 $, $Date: 2008/12/10 00:59:51 $

Author: Brett McLaughlin Jason Hunter

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

Method Summary
Throwable	getCause() This will return the root cause `Throwable`, or null if one does not exist.
String	getMessage() This returns the message for the `Exception`.
Throwable	initCause(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(PrintStream s) Prints the stack trace of the `Exception` to the given PrintStream.
void	printStackTrace(PrintWriter w) Prints the stack trace of the `Exception` to the given PrintWriter.

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

Parameters: message String message indicating the problem that occurred. cause Throwable that caused this to be thrown.

Method Detail

getCause

public Throwable getCause()

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

Returns: Throwable - the wrapped Throwable.

getMessage

public String getMessage()

This returns the message for the Exception. If there are one or more nested exceptions, their messages are appended.

Returns: String - message for Exception.

initCause

public Throwable initCause(Throwable cause)

Intializes the cause of this exception to be the specified value.

Parameters: cause Throwable that caused this to be thrown.

Returns: a pointer to this 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)

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.

Parameters: s PrintStream to print to

printStackTrace

public void printStackTrace(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.

Parameters: w PrintWriter to print to