org.jdom

Class JDOMException

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.

Version: $Revision: 1.11 $, $Date: 2002/01/08 09:17:10 $

Author: Brett McLaughlin Jason Hunter

Field Summary
protected Throwable	cause A wrapped `Throwable`

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) This prints the stack trace of the `Exception` to the given PrintStream.
void	printStackTrace(PrintWriter w) This prints the stack trace of the `Exception` to the given PrintWriter.

Field Detail

cause

protected Throwable cause

A wrapped Throwable

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.