Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.apache.commons.lang.exception
Class ThrowableNestedNestable  view ThrowableNestedNestable download ThrowableNestedNestable.java

java.lang.Object
  extended byjava.lang.Throwable
      extended byorg.apache.commons.lang.exception.ThrowableNestedNestable
All Implemented Interfaces:
Nestable, java.io.Serializable

class ThrowableNestedNestable
extends java.lang.Throwable
implements Nestable

Nestable and Throwable class which takes in a 'cause' object. Returns a message wrapping the 'cause' message Prints a fixed stack trace and partial stack trace.


Nested Class Summary
 
Nested classes inherited from class java.lang.Throwable
 
Field Summary
private  java.lang.Throwable cause
           
 
Fields inherited from class java.lang.Throwable
 
Constructor Summary
ThrowableNestedNestable(java.lang.Throwable cause)
           
 
Method Summary
 java.lang.Throwable getCause()
          Returns the reference to the exception or error that caused the exception implementing the Nestable to be thrown.
 java.lang.String getMessage()
          Returns the error message of this and any nested Throwable.
 java.lang.String getMessage(int index)
          Returns the error message of the Throwable in the chain of Throwables at the specified index, numbered from 0.
 java.lang.String[] getMessages()
          Returns the error message of this and any nested Throwables in an array of Strings, one element for each message.
 java.lang.Throwable getThrowable(int index)
          Returns the Throwable in the chain of Throwables at the specified index, numbered from 0.
 int getThrowableCount()
          Returns the number of nested Throwables represented by this Nestable, including this Nestable.
 java.lang.Throwable[] getThrowables()
          Returns this Nestable and any nested Throwables in an array of Throwables, one element for each Throwable.
 int indexOfThrowable(java.lang.Class type)
          Returns the index, numbered from 0, of the first occurrence of the specified type, or a subclass, in the chain of Throwables.
 int indexOfThrowable(java.lang.Class type, int fromIndex)
          Returns the index, numbered from 0, of the first Throwable that matches the specified type, or a subclass, in the chain of Throwables with an index greater than or equal to the specified index.
 void printPartialStackTrace(java.io.PrintWriter out)
          Prints the stack trace for this exception only--root cause not included--using the provided writer.
 void printStackTrace(java.io.PrintWriter out)
          Prints the stack trace of this exception to the specified print writer.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.apache.commons.lang.exception.Nestable
printStackTrace
 

Field Detail

cause

private java.lang.Throwable cause
Constructor Detail

ThrowableNestedNestable

public ThrowableNestedNestable(java.lang.Throwable cause)
Method Detail

getThrowableCount

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

Specified by:
getThrowableCount in interface Nestable

getMessage

public java.lang.String getMessage()
Description copied from interface: Nestable
Returns the error message of this and any nested Throwable.

Specified by:
getMessage in interface Nestable

getMessage

public java.lang.String getMessage(int index)
Description copied from interface: Nestable
Returns the error message of the Throwable in the chain of Throwables at the specified index, numbered from 0.

Specified by:
getMessage in interface Nestable

getMessages

public java.lang.String[] getMessages()
Description copied from interface: Nestable
Returns the error message of this and any nested Throwables in an array of Strings, one element for each message. Any Throwable not containing a message is represented in the array by a null. This has the effect of cause the length of the returned array to be equal to the result of the Nestable.getThrowableCount() 55 operation.

Specified by:
getMessages in interface Nestable

getCause

public java.lang.Throwable getCause()
Description copied from interface: Nestable
Returns the reference to the exception or error that caused the exception implementing the Nestable to be thrown.

Specified by:
getCause in interface Nestable

printStackTrace

public void printStackTrace(java.io.PrintWriter out)
Description copied from interface: Nestable
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

printPartialStackTrace

public void printPartialStackTrace(java.io.PrintWriter out)
Description copied from interface: Nestable
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

getThrowable

public java.lang.Throwable getThrowable(int index)
Description copied from interface: Nestable
Returns the Throwable in the chain of Throwables at the specified index, numbered from 0.

Specified by:
getThrowable in interface Nestable

getThrowables

public java.lang.Throwable[] getThrowables()
Description copied from interface: Nestable
Returns this Nestable and any nested Throwables in an array of Throwables, one element for each Throwable.

Specified by:
getThrowables in interface Nestable

indexOfThrowable

public int indexOfThrowable(java.lang.Class type)
Description copied from interface: Nestable
Returns the index, numbered from 0, of the first occurrence of the specified type, or a subclass, in the chain of Throwables. The method returns -1 if the specified type is not found in the chain.

NOTE: From v2.1, we have clarified the Nestable interface such that this method matches subclasses. If you want to NOT match subclasses, please use ExceptionUtils.indexOfThrowable(Throwable, Class) 55 (which is avaiable in all versions of lang).

Specified by:
indexOfThrowable in interface Nestable

indexOfThrowable

public int indexOfThrowable(java.lang.Class type,
                            int fromIndex)
Description copied from interface: Nestable
Returns the index, numbered from 0, of the first Throwable that matches the specified type, or a subclass, in the chain of Throwables with an index greater than or equal to the specified index. The method returns -1 if the specified type is not found in the chain.

NOTE: From v2.1, we have clarified the Nestable interface such that this method matches subclasses. If you want to NOT match subclasses, please use ExceptionUtils.indexOfThrowable(Throwable, Class, int) 55 (which is avaiable in all versions of lang).

Specified by:
indexOfThrowable in interface Nestable