java.lang
Class Throwable

java.lang.Object
  java.lang.Throwable

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Error, Exception, MailboxNotAvailableException

public class Throwable
extends Object
implements Serializable

This class is the superclass of all classes which can be thrown by the virtual machine. The two direct subclasses represent recoverable exceptions (Exception) and unrecoverable errors (Error). This class provides common methods for accessing a string message which provides extra information about the circumstances in which the Throwable was created, and for filling in a stack trace (i.e., a record of the call stack at a particular point in time) which can be printed later.

See Also:

Error, Exception, RuntimeException, Serialized Form

Constructor Summary

Throwable()
Constructs a new instance of this class with its stack trace filled in.

Throwable(String detailMessage)
Constructs a new instance of this class with its stack trace and message filled in.

Throwable(String detailMessage, Throwable throwable)
Constructs a new instance of this class with its stack trace, message, and cause filled in.

Throwable(Throwable throwable)
Constructs a new instance of this class with its stack trace and cause filled in.

Method Summary

Throwable	fillInStackTrace() Records in the receiver a stack trace from the point where this message was sent.
Throwable	getCause() Returns the cause of this Throwable, or null if there is no cause.
String	getLocalizedMessage() Returns the extra information message which was provided when the throwable was created.
String	getMessage() Returns the extra information message which was provided when the throwable was created.
StackTraceElement[]	getStackTrace() Returns an array of StackTraceElement.
Throwable	initCause(Throwable throwable) Initialize the cause of the receiver.
void	printStackTrace() Outputs a printable representation of the receiver's stack trace on the System.err stream.
void	printStackTrace(PrintStream err) Outputs a printable representation of the receiver's stack trace on the PrintStream specified by the argument.
void	printStackTrace(PrintWriter err) Outputs a printable representation of the receiver's stack trace on the PrintWriter specified by the argument.
void	setStackTrace(StackTraceElement[] trace) Sets the array of StackTraceElements.
String	toString() Returns a string containing a concise, human-readable description of the receiver.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Throwable

public Throwable()

Constructs a new instance of this class with its stack trace filled in.

Throwable

public Throwable(String detailMessage)

Constructs a new instance of this class with its stack trace and message filled in.

Parameters:

detailMessage - String The detail message for the exception.

Throwable

public Throwable(String detailMessage,
                 Throwable throwable)

Constructs a new instance of this class with its stack trace, message, and cause filled in.

Parameters:

detailMessage - String The detail message for the exception.

throwable - The cause of this Throwable

Throwable

public Throwable(Throwable throwable)

Constructs a new instance of this class with its stack trace and cause filled in.

Parameters:

throwable - The cause of this Throwable

Method Detail

fillInStackTrace

public Throwable fillInStackTrace()

Records in the receiver a stack trace from the point where this message was sent. The method is public so that code which catches a throwable and then re-throws it can adjust the stack trace to represent the location where the exception was re-thrown.

Returns:

the receiver

getMessage

public String getMessage()

Returns the extra information message which was provided when the throwable was created. If no message was provided at creation time, then return null.

Returns:

String The receiver's message.

getLocalizedMessage

public String getLocalizedMessage()

Returns the extra information message which was provided when the throwable was created. If no message was provided at creation time, then return null. Subclasses may override this method to return localized text for the message.

Returns:

String The receiver's message.

getStackTrace

public StackTraceElement[] getStackTrace()

Returns an array of StackTraceElement. Each StackTraceElement represents a entry on the stack.

Returns:

an array of StackTraceElement representing the stack

setStackTrace

public void setStackTrace(StackTraceElement[] trace)

Sets the array of StackTraceElements. Each StackTraceElement represents a entry on the stack. A copy of this array will be returned by getStackTrace() and printed by printStackTrace().

Parameters:

trace - The array of StackTraceElement

printStackTrace

public void printStackTrace()

Outputs a printable representation of the receiver's stack trace on the System.err stream.

printStackTrace

public void printStackTrace(PrintStream err)

Outputs a printable representation of the receiver's stack trace on the PrintStream specified by the argument.

Parameters:

err - PrintStream The stream to write the stack trace on.

printStackTrace

public void printStackTrace(PrintWriter err)

Outputs a printable representation of the receiver's stack trace on the PrintWriter specified by the argument.

Parameters:

err - PrintWriter The writer to write the stack trace on.

toString

public String toString()

Returns a string containing a concise, human-readable description of the receiver.

Overrides:

toString in class Object

Returns:

String a printable representation for the receiver.

initCause

public Throwable initCause(Throwable throwable)

Initialize the cause of the receiver. The cause cannot be reassigned.

Parameters:

throwable - The cause of this Throwable

Returns:

the receiver.

Throws:

IllegalArgumentException - when the cause is the receiver

IllegalStateException - when the cause has already been initialized

getCause

public Throwable getCause()

Returns the cause of this Throwable, or null if there is no cause.

Returns:

Throwable The receiver's cause.