IBM WebSphere Extended Deployment (XD)TM
Release 6.0.1

com.ibm.websphere.objectgrid
ObjectGridException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--com.ibm.websphere.objectgrid.ObjectGridException
All Implemented Interfaces
IObjectGridException, Serializable





Constructor Summary
ObjectGridException()
           Constructs a new ObjectGridException with null as its detail message.
ObjectGridException(java.lang.String)
           Constructs a new ObjectGridException with the specified detail message. The.
ObjectGridException(java.lang.Throwable)
           Constructs a new ObjectGridException with a specified cause..
ObjectGridException(java.lang.String, java.lang.Throwable)
           Constructs a new ObjectGridException with the specified detail message and cause.


Method Summary
public  ThrowablegetCause()
           Returns the cause of this throwable or null if the cause is nonexistent or unknown.
public  ThrowableinitCause(java.lang.Throwable)
           Initializes the cause of this throwable to the specified value..
public  voidprintStackTrace()
           Print this ObjectGridException and its backtrace to System.
public  voidprintStackTrace(java.io.PrintStream)
           Print this ObjectGridException and its backtrace to the specified print stream.
public  voidprintStackTrace(java.io.PrintWriter)
           Print this ObjectGridException and its backtrace to the specified print writer.

Inherited Methods

Methods inherited from java.lang.Throwable
fillInStackTrace, getLocalizedMessage, getMessage, getStackTrace, setStackTrace, toString
Methods inherited from java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ObjectGridException

public ObjectGridException( )
Constructs a new ObjectGridException with null as its detail message. The cause is not initialized, and may subsequently be initialized by a call to #initCause(Throwable).


ObjectGridException

public ObjectGridException( String message)
Constructs a new ObjectGridException with the specified detail message. The cause is not initialized, and may subsequently be initialized by a call to #initCause(Throwable).
Parameters:
message - the detail message. The detail message is saved for later retrieval by the #getMessage()method.


ObjectGridException

public ObjectGridException( Throwable cause)
Constructs a new ObjectGridException with a specified cause. The cause and a detail message of (cause==null ? null : cause.toString()) is used (which typically contains the class and detail message of cause). This constructor is useful for ObjectGridExceptions that are little more than wrappers for other throwables.
Parameters:
cause - is the exception that caused this exception to be thrown, which is saved for later retrieval by the #getCause() method. A null value is permitted and indicates that the cause is nonexistent or is unknown.


ObjectGridException

public ObjectGridException( String message,Throwable cause)
Constructs a new ObjectGridException with the specified detail message and cause.

Note that the detail message associated with cause is not automatically incorporated in this ObjectGridException's detail message.

Parameters:
message - the detail message (which is saved for later retrieval by the #getMessage()method).
cause - the cause (which is saved for later retrieval by the #getCause()method). (Anull value is permitted, and indicates that the cause is nonexistent or unknown.)


Method Detail

getCause

public Throwable getCause()
Returns the cause of this throwable or null if the cause is nonexistent or unknown. (The cause is the throwable that caused this throwable to get thrown.)

This implementation returns the cause that was supplied via one of the constructors requiring a Throwable, or that was set after creation with the #initCause(Throwable) method. While it is typically unnecessary to override this method, a subclass can override it to return a cause set by some other means. This is appropriate for a "legacy chained throwable" that predates the addition of chained exceptions to Throwable. Note that it is not necessary to override any of the PrintStackTrace methods, all of which invoke the getCause method to determine the cause of a throwable.



Returns:
     the cause of this throwable or null if the cause is nonexistent or unknown.


initCause

public Throwable initCause(Throwable cause)
Initializes the cause of this throwable to the specified value. (The cause is the throwable that caused this throwable to get thrown.)

This method can be called at most once. It is generally called from within the constructor, or immediately after creating the throwable. If this throwable was created with #Throwable(Throwable) or #Throwable(String,Throwable), this method cannot be called even once.

Parameters:
    cause - the cause (which is saved for later retrieval by the #getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)


Returns:
     a reference to this Throwable instance.


Throws:
    java.lang.IllegalArgumentExceptionjava.lang.IllegalStateException


printStackTrace

public void printStackTrace()
Print this ObjectGridException and its backtrace to System.err.


printStackTrace

public void printStackTrace(PrintStream stream)
Print this ObjectGridException and its backtrace to the specified print stream.

Parameters:
    stream - the PrintStream to use for output


printStackTrace

public void printStackTrace(PrintWriter writer)
Print this ObjectGridException and its backtrace to the specified print writer.

Parameters:
    writer - the PrintWriter to use for output


IBM WebSphere Extended Deployment (XD)TM
Release 6.0.1