org.springframework.core
Class NestedCheckedException

java.lang.Object
  extended byjava.lang.Throwable
      extended byjava.lang.Exception
          extended byorg.springframework.core.NestedCheckedException
All Implemented Interfaces:
java.io.Serializable

public abstract class NestedCheckedException
extends java.lang.Exception

Handy class for wrapping runtime Exceptions with a root cause. This time-honoured technique is no longer necessary in Java 1.4, which provides built-in support for exception nesting. Thus exceptions in applications written to use Java 1.4 need not extend this class.

Abstract to force the programmer to extend the class. printStackTrace() etc. are forwarded to the wrapped Exception. The present assumption is that all application-specific exceptions that could be displayed to humans (users, administrators etc.) will implement the ErrorCoded interface.

The similarity between this class and the NestedCheckedException class is unavoidable, as Java forces these two classes to have different superclasses (ah, the inflexibility of concrete inheritance!).

As discussed in Expert One-On-One J2EE Design and Development, runtime exceptions are often a better alternative to checked exceptions. However, all exceptions should preserve their stack trace, if caused by a lower-level exception.

Version:
$Id: NestedCheckedException.java,v 1.6 2004/03/18 02:46:06 trisberg Exp $
Author:
Rod Johnson
See Also:
Serialized Form

Constructor Summary
NestedCheckedException(java.lang.String msg)
          Construct a ExceptionWrapperException with the specified detail message.
NestedCheckedException(java.lang.String msg, java.lang.Throwable ex)
          Construct a RemoteException with the specified detail message and nested exception.
 
Method Summary
 java.lang.Throwable getCause()
          Return the nested cause, or null if none.
 java.lang.String getMessage()
          Return the detail message, including the message from the nested exception if there is one.
 void printStackTrace(java.io.PrintStream ps)
          Print the composite message and the embedded stack trace to the specified stream.
 void printStackTrace(java.io.PrintWriter pw)
          Prints the composite message and the embedded stack trace to the specified print writer.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getLocalizedMessage, getStackTrace, initCause, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

NestedCheckedException

public NestedCheckedException(java.lang.String msg)
Construct a ExceptionWrapperException with the specified detail message.

Parameters:
msg - the detail message

NestedCheckedException

public NestedCheckedException(java.lang.String msg,
                              java.lang.Throwable ex)
Construct a RemoteException with the specified detail message and nested exception.

Parameters:
msg - the detail message
ex - the nested exception
Method Detail

getCause

public java.lang.Throwable getCause()
Return the nested cause, or null if none.


getMessage

public java.lang.String getMessage()
Return the detail message, including the message from the nested exception if there is one.


printStackTrace

public void printStackTrace(java.io.PrintStream ps)
Print the composite message and the embedded stack trace to the specified stream.

Parameters:
ps - the print stream

printStackTrace

public void printStackTrace(java.io.PrintWriter pw)
Prints the composite message and the embedded stack trace to the specified print writer.

Parameters:
pw - the print writer


Copyright (C) 2003-2004 The Spring Framework Project.