org.exolab.castor.util

Class NestedIOException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.io.IOException

org.exolab.castor.util.NestedIOException

All Implemented Interfaces:

Serializable

public class NestedIOException
extends IOException

An exception that is used to signal I/O errors which are caused by other exceptions. This class allows the user get to the original exception.

Version:

$Revision$ $Date: 2005-12-13 14:58:48 -0700 (Tue, 13 Dec 2005) $

Author:

Keith Visco

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NestedIOException() Creates a new NestedIOException with no message, or nested Exception
NestedIOException(Exception exception) Creates a new NestedIOException with the given nested exception.
NestedIOException(String message) Creates a new NestedIOException with the given message.
NestedIOException(String message, Exception exception) Creates a new NestedIOException with the given message and nested exception.

Method Summary

Modifier and Type	Method and Description
Exception	getException() Returns the exception, which in turn caused this Exception to be thrown, or null if nested exception exists.
void	printStackTrace()
void	printStackTrace(PrintStream printer)
void	printStackTrace(PrintWriter printer)
void	setLocalStackTraceOnly(boolean localTrace) Sets whether or not to print the local stack trace or the nested stack trace when calls to #printStackTrace are made.
String	toString() Returns the String representation of this Exception.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, setStackTrace

Methods inherited from class java.lang.Object

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

Constructor Detail

NestedIOException

public NestedIOException()

Creates a new NestedIOException with no message, or nested Exception

NestedIOException

public NestedIOException(String message)

Creates a new NestedIOException with the given message.

Parameters:

message - the message for this Exception

NestedIOException

public NestedIOException(Exception exception)

Creates a new NestedIOException with the given nested exception.

Parameters:

exception - the nested exception. (Must not be null).

NestedIOException

public NestedIOException(String message,
                         Exception exception)

Creates a new NestedIOException with the given message and nested exception.

Parameters:

message - the detail message for this exception

exception - the nested exception

Method Detail

getException

public Exception getException()

Returns the exception, which in turn caused this Exception to be thrown, or null if nested exception exists.

Returns:

the exception, which in turn caused this Exception to be thrown, or null if nested exception exists.

setLocalStackTraceOnly

public void setLocalStackTraceOnly(boolean localTrace)

Sets whether or not to print the local stack trace or the nested stack trace when calls to #printStackTrace are made. By default the nested exception is used for printing stack trace.

Parameters:

localTrace - a boolean when true enables local stack trace only.

toString

public String toString()

Returns the String representation of this Exception.

Overrides:

toString in class Throwable

Returns:

the String representation of this Exception.

printStackTrace

public void printStackTrace()

Overrides:

printStackTrace in class Throwable

printStackTrace

public void printStackTrace(PrintWriter printer)

Overrides:

printStackTrace in class Throwable

printStackTrace

public void printStackTrace(PrintStream printer)

Overrides:

printStackTrace in class Throwable