org.apache.commons.lang.exception

Class NestableError

Implemented Interfaces:
Nestable

public class NestableError
extends Error
implements Nestable

The base class of all errors which can contain other exceptions.

Version:
$Id: NestableError.java,v 1.7 2003/08/18 02:22:24 bayard Exp $

Author:
Daniel Rall

Since:
1.0

See Also:
NestableException

Field Summary

protected NestableDelegate
delegate
The helper instance which contains much of the code which we delegate to.

Constructor Summary

NestableError()
Constructs a new NestableError without specified detail message.
NestableError(String msg)
Constructs a new NestableError with specified detail message.
NestableError(String msg, Throwable cause)
Constructs a new NestableError with specified detail message and nested Throwable.
NestableError(Throwable cause)
Constructs a new NestableError with specified nested Throwable.

Method Summary

Throwable
getCause()
Returns the reference to the exception or error that caused the exception implementing the Nestable to be thrown.
String
getMessage()
Returns the detail message string of this throwable.
String
getMessage(int index)
Returns the error message of the Throwable in the chain of Throwables at the specified index, numbererd from 0.
String[]
getMessages()
Returns the error message of this and any nested Throwables in an array of Strings, one element for each message.
Throwable
getThrowable(int index)
Returns the Throwable in the chain of Throwables at the specified index, numbererd from 0.
int
getThrowableCount()
Returns the number of nested Throwables represented by this Nestable, including this Nestable.
Throwable[]
getThrowables()
Returns this Nestable and any nested Throwables in an array of Throwables, one element for each Throwable.
int
indexOfThrowable(Class type)
Returns the index, numbered from 0, of the first occurrence of the specified type in the chain of Throwables, or -1 if the specified type is not found in the chain.
int
indexOfThrowable(Class type, int fromIndex)
Returns the index, numbered from 0, of the first Throwable that matches the specified type in the chain of Throwables with an index greater than or equal to the specified index, or -1 if the type is not found.
void
printPartialStackTrace(PrintWriter out)
Prints the stack trace for this exception only--root cause not included--using the provided writer.
void
printStackTrace()
void
printStackTrace(PrintStream out)
Prints the stack trace of this exception to the specified print stream.
void
printStackTrace(PrintWriter out)
Prints the stack trace of this exception to the specified print writer.

Field Details

delegate

protected NestableDelegate delegate
The helper instance which contains much of the code which we delegate to.

Constructor Details

NestableError

public NestableError()
Constructs a new NestableError without specified detail message.


NestableError

public NestableError(String msg)
Constructs a new NestableError with specified detail message.

Parameters:
msg - The error message.


NestableError

public NestableError(String msg,
                     Throwable cause)
Constructs a new NestableError with specified detail message and nested Throwable.

Parameters:
msg - the error message
cause - the exception or error that caused this exception to be thrown


NestableError

public NestableError(Throwable cause)
Constructs a new NestableError with specified nested Throwable.

Parameters:
cause - the exception or error that caused this exception to be thrown

Method Details

getCause

public Throwable getCause()
Returns the reference to the exception or error that caused the exception implementing the Nestable to be thrown.
Specified by:
getCause in interface Nestable

Returns:
throwable that caused the original exception


getMessage

public String getMessage()
Returns the detail message string of this throwable. If it was created with a null message, returns the following: (cause==null ? null : cause.toString()).
Specified by:
getMessage in interface Nestable


getMessage

public String getMessage(int index)
Returns the error message of the Throwable in the chain of Throwables at the specified index, numbererd from 0.
Specified by:
getMessage in interface Nestable

Parameters:
index - the index of the Throwable in the chain of Throwables

Returns:
the error message, or null if the Throwable at the specified index in the chain does not contain a message


getMessages

public String[] getMessages()
Specified by:
getMessages in interface Nestable

Returns:
the error messages


getThrowable

public Throwable getThrowable(int index)
Returns the Throwable in the chain of Throwables at the specified index, numbererd from 0.
Specified by:
getThrowable in interface Nestable

Parameters:
index - the index, numbered from 0, of the Throwable in the chain of Throwables

Returns:
the Throwable


getThrowableCount

public int getThrowableCount()
Returns the number of nested Throwables represented by this Nestable, including this Nestable.
Specified by:
getThrowableCount in interface Nestable

Returns:
the throwable count


getThrowables

public Throwable[] getThrowables()
Returns this Nestable and any nested Throwables in an array of Throwables, one element for each Throwable.
Specified by:
getThrowables in interface Nestable

Returns:
the Throwables


indexOfThrowable

public int indexOfThrowable(Class type)
Returns the index, numbered from 0, of the first occurrence of the specified type in the chain of Throwables, or -1 if the specified type is not found in the chain.
Specified by:
indexOfThrowable in interface Nestable

Parameters:
type - Class to be found

Returns:
index of the first occurrence of the type in the chain, or -1 if the type is not found


indexOfThrowable

public int indexOfThrowable(Class type,
                            int fromIndex)
Returns the index, numbered from 0, of the first Throwable that matches the specified type in the chain of Throwables with an index greater than or equal to the specified index, or -1 if the type is not found.
Specified by:
indexOfThrowable in interface Nestable

Parameters:
type - Class to be found
fromIndex - the index, numbered from 0, of the starting position in the chain to be searched

Returns:
index of the first occurrence of the type in the chain, or -1 if the type is not found


printPartialStackTrace

public final void printPartialStackTrace(PrintWriter out)
Prints the stack trace for this exception only--root cause not included--using the provided writer. Used by NestableDelegate to write individual stack traces to a buffer. The implementation of this method should call super.printStackTrace(out); in most cases.
Specified by:
printPartialStackTrace in interface Nestable

Parameters:
out - The writer to use.


printStackTrace

public void printStackTrace()


printStackTrace

public void printStackTrace(PrintStream out)
Prints the stack trace of this exception to the specified print stream. Includes inforamation from the exception, if any, which caused this exception.
Specified by:
printStackTrace in interface Nestable

Parameters:
out - PrintStream to use for output.


printStackTrace

public void printStackTrace(PrintWriter out)
Prints the stack trace of this exception to the specified print writer. Includes information from the exception, if any, which caused this exception.
Specified by:
printStackTrace in interface Nestable

Parameters:
out - PrintWriter to use for output.


Copyright © 2001-2003 - Apache Software Foundation