- All Implemented Interfaces:
Serializable
Throwable
class is the superclass of all errors and exceptions in the Java language. Only objects that are instances of this class (or one of its subclasses) are thrown by the Java Virtual Machine or can be thrown by the Java throw
statement. Similarly, only this class or one of its subclasses can be the argument type in a catch
clause. For the purposes of compile-time checking of exceptions, Throwable
and any subclass of Throwable
that is not also a subclass of either RuntimeException
or Error
are regarded as checked exceptions. Instances of two subclasses, Error
and Exception
, are conventionally used to indicate that exceptional situations have occurred. Typically, these instances are freshly created in the context of the exceptional situation so as to include relevant information (such as stack trace data).
A throwable contains a snapshot of the execution stack of its thread at the time it was created. It can also contain a message string that gives more information about the error. Over time, a throwable can suppress other throwables from being propagated. Finally, the throwable can also contain a cause: another throwable that caused this throwable to be constructed. The recording of this causal information is referred to as the chained exception facility, as the cause can, itself, have a cause, and so on, leading to a "chain" of exceptions, each caused by another.
One reason that a throwable may have a cause is that the class that throws it is built atop a lower layered abstraction, and an operation on the upper layer fails due to a failure in the lower layer. It would be bad design to let the throwable thrown by the lower layer propagate outward, as it is generally unrelated to the abstraction provided by the upper layer. Further, doing so would tie the API of the upper layer to the details of its implementation, assuming the lower layer's exception was a checked exception. Throwing a "wrapped exception" (i.e., an exception containing a cause) allows the upper layer to communicate the details of the failure to its caller without incurring either of these shortcomings. It preserves the flexibility to change the implementation of the upper layer without changing its API (in particular, the set of exceptions thrown by its methods).
A second reason that a throwable may have a cause is that the method that throws it must conform to a general-purpose interface that does not permit the method to throw the cause directly. For example, suppose a persistent collection conforms to the Collection
interface, and that its persistence is implemented atop java.io
. Suppose the internals of the add
method can throw an IOException
. The implementation can communicate the details of the IOException
to its caller while conforming to the Collection
interface by wrapping the IOException
in an appropriate unchecked exception. (The specification for the persistent collection should indicate that it is capable of throwing such exceptions.)
A cause can be associated with a throwable in two ways: via a constructor that takes the cause as an argument, or via the initCause(Throwable)
method. New throwable classes that wish to allow causes to be associated with them should provide constructors that take a cause and delegate (perhaps indirectly) to one of the Throwable
constructors that takes a cause. Because the initCause
method is public, it allows a cause to be associated with any throwable, even a "legacy throwable" whose implementation predates the addition of the exception chaining mechanism to Throwable
.
By convention, class Throwable
and its subclasses have two constructors, one that takes no arguments and one that takes a String
argument that can be used to produce a detail message. Further, those subclasses that might likely have a cause associated with them should have two more constructors, one that takes a Throwable
(the cause), and one that takes a String
(the detail message) and a Throwable
(the cause).
- See Java Language Specification:
- Moved out of a link with destination https://docs.oracle.com/javase/specs/jls/se20/html/jls-11.html#jls-11.2.Moved to a link with destination https://docs.oracle.com/javase/specs/jls/se21/html/jls-11.html#jls-11.2. Moved out of a link with destination https://docs.oracle.com/javase/specs/jls/se20/html/jls-11.html#jls-11.2.Moved to a link with destination https://docs.oracle.com/javase/specs/jls/se21/html/jls-11.html#jls-11.2.11.2 Compile-Time Checking of Exceptions
- Since:
- 1.0
- See Also:
Constructors
- ✓public Throwable()
- ✓public Throwable(java.lang.String arg0)
- ✓public Throwable(java.lang.String arg0, java.lang.Throwable arg1)
- ✓protected Throwable(java.lang.String arg0, java.lang.Throwable arg1, boolean arg2, boolean arg3)
- ✓public Throwable(java.lang.Throwable arg0)
Methods
- ✓public final void addSuppressed(java.lang.Throwable arg0)
- ✓public java.lang.Throwable fillInStackTrace()
- ✓public java.lang.Throwable getCause()
- ✓public java.lang.String getLocalizedMessage()
- ✓public java.lang.String getMessage()
- ✓public java.lang.StackTraceElement[] getStackTrace()
- ✓public final java.lang.Throwable[] getSuppressed()
- ✓public java.lang.Throwable initCause(java.lang.Throwable arg0)
- ✓public void printStackTrace()
- ✓public void printStackTrace(java.io.PrintStream arg0)
- ✓public void printStackTrace(java.io.PrintWriter arg0)
- ✓public void setStackTrace(java.lang.StackTraceElement[] arg0)
- ✓public java.lang.String toString()
Serialized Form
✓serialVersionUID
✓-3042686055658047285Serialized Fields
- ✓java.lang.Throwable cause
- ✓java.lang.String detailMessage
- ✓java.lang.StackTraceElement[] stackTrace
- ✓java.util.List<java.lang.Throwable> suppressedExceptions
Serialization Methods
- ✓private void readObject(java.io.ObjectInputStream arg0) throws java.io.IOException, java.lang.ClassNotFoundException
- ✓private void writeObject(java.io.ObjectOutputStream arg0) throws java.io.IOException
Summary
| Elements | Comments | Descriptions | Total | |||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Added | Changed | Removed | Added | Changed | Removed | Added | Changed | Removed | ||
| Throwable | 1 | 1 | ||||||||
| Total | 1 | 1 | ||||||||