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

Quick Search    Search Deep
Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> org >> apache >> commons >> lang >> [ exception overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of org.apache.commons.lang.exception.NestableError JAVADOC | Sourc code of org.apache.commons.lang.exception.NestableError SOURCE | Download org.apache.commons.lang.exception.NestableError DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

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

java.lang.Object
  extended byjava.lang.Throwable
      extended byjava.lang.Error
          extended byorg.apache.commons.lang.exception.NestableError
All Implemented Interfaces:
Nestable, java.io.Serializable
Direct Known Subclasses:
NestableErrorTester1, NestableErrorTester2
public class NestableError
extends java.lang.Error
implements Nestable

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

Since:
1.0
Version:
$Id: NestableError.java 161243 2005-04-14 04:30:28Z ggregory $

Nested Class Summary
 
Nested classes inherited from class java.lang.Throwable
 
Field Summary
private  java.lang.Throwable cause
          Holds the reference to the exception or error that caused this exception to be thrown.
protected  NestableDelegate delegate
          The helper instance which contains much of the code which we delegate to.
 
Fields inherited from class java.lang.Error
 
Fields inherited from class java.lang.Throwable
 
Constructor Summary
NestableError()
          Constructs a new NestableError without specified detail message.
NestableError(java.lang.String msg)
          Constructs a new NestableError with specified detail message.
NestableError(java.lang.String msg, java.lang.Throwable cause)
          Constructs a new NestableError with specified detail message and nested Throwable.
NestableError(java.lang.Throwable cause)
          Constructs a new NestableError with specified nested Throwable.
 
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 detail message string of this 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()
          Print a stack trace to the standard error stream.
 void printStackTrace(java.io.PrintStream out)
          Prints the stack trace of this exception to the specified print stream.
 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, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

delegate

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

cause

private java.lang.Throwable cause
Holds the reference to the exception or error that caused this exception to be thrown.

Constructor Detail

NestableError

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

NestableError

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

NestableError

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

NestableError

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

Method Detail

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

getMessage

public java.lang.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 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

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

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

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

printStackTrace

public void printStackTrace()
Description copied from class: java.lang.Throwable
Print a stack trace to the standard error stream. This stream is the current contents of System.err. The first line of output is the result of Throwable.toString()>Throwable.toString() 55 , and the remaining lines represent the data created by Throwable.fillInStackTrace()>Throwable.fillInStackTrace() 55 . While the format is unspecified, this implementation uses the suggested format, demonstrated by this example:
 public class Junk
 {
   public static void main(String args[])
   {
     try
       {
         a();
       }
     catch(HighLevelException e)
       {
         e.printStackTrace();
       }
   }
   static void a() throws HighLevelException
   {
     try
       {
         b();
       }
     catch(MidLevelException e)
       {
         throw new HighLevelException(e);
       }
   }
   static void b() throws MidLevelException
   {
     c();
   }
   static void c() throws MidLevelException
   {
     try
       {
         d();
       }
     catch(LowLevelException e)
       {
         throw new MidLevelException(e);
       }
   }
   static void d() throws LowLevelException
   {
     e();
   }
   static void e() throws LowLevelException
   {
     throw new LowLevelException();
   }
 }
 class HighLevelException extends Exception
 {
   HighLevelException(Throwable cause) { super(cause); }
 }
 class MidLevelException extends Exception
 {
   MidLevelException(Throwable cause)  { super(cause); }
 }
 class LowLevelException extends Exception
 {
 }
 

  HighLevelException: MidLevelException: LowLevelException
          at Junk.a(Junk.java:13)
          at Junk.main(Junk.java:4)
  Caused by: MidLevelException: LowLevelException
          at Junk.c(Junk.java:23)
          at Junk.b(Junk.java:17)
          at Junk.a(Junk.java:11)
          ... 1 more
  Caused by: LowLevelException
          at Junk.e(Junk.java:30)
          at Junk.d(Junk.java:27)
          at Junk.c(Junk.java:21)
          ... 3 more

printStackTrace

public void printStackTrace(java.io.PrintStream out)
Description copied from interface: Nestable
Prints the stack trace of this exception to the specified print stream. Includes information from the exception, if any, which caused this exception.

Specified by:
printStackTrace 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 final 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
Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> org >> apache >> commons >> lang >> [ exception overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of org.apache.commons.lang.exception.NestableError JAVADOC | Sourc code of org.apache.commons.lang.exception.NestableError SOURCE | Download org.apache.commons.lang.exception.NestableError DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD