IBM WebSphereTM eXtreme Scale, Release 8.6
API Specification

com.ibm.websphere.objectgrid
Class ObjectGridRuntimeException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by java.lang.RuntimeException
              extended by com.ibm.websphere.objectgrid.ObjectGridRuntimeException
All Implemented Interfaces:
IObjectGridException, Serializable
Direct Known Subclasses:
AvailabilityException, AvailabilityTransitionException, DataDescriptorException, GlobalIndexException, IncompatibleDeploymentPolicyException, LifecycleFailedException, MixedTransportException, ObjectQueryException, PersistenceException, PlacementException, QuorumException, TransactionTimeoutException

public class ObjectGridRuntimeException
extends RuntimeException
implements IObjectGridException

This exception is the base class for all runtime exceptions thrown by the cache.

Since:
WAS XD 6.0, XC10
See Also:
Serialized Form

Constructor Summary
ObjectGridRuntimeException()
          Constructs a new ObjectGridRuntimeException with null as its detail message.
ObjectGridRuntimeException(String message)
          Constructs a new ObjectGridRuntimeException with the specified detail message.
ObjectGridRuntimeException(String message, Throwable cause)
          Constructs a new ObjectGridRuntimeException with the specified detail message and cause.
ObjectGridRuntimeException(Throwable cause)
          Constructs a new ObjectGridRuntimeException with a specified cause.
 
Method Summary
 Throwable getCause()
          Returns the cause of this ObjectGridRuntimeException or null if the cause is nonexistent or unknown.
 Throwable initCause(Throwable cause)
          Initializes the cause of this ObjectGridRuntimeException to the specified value.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getLocalizedMessage, getMessage, getStackTrace, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ObjectGridRuntimeException

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

See Also:
initCause(Throwable)

ObjectGridRuntimeException

public ObjectGridRuntimeException(String message)
Constructs a new ObjectGridRuntimeException with the specified detail message. The cause is not initialized, and may subsequently be initialized by a call to the initCause method.

Parameters:
message - the detail message. The detail message is saved for later retrieval by the getMessage method.
See Also:
initCause(Throwable), Throwable.getMessage()

ObjectGridRuntimeException

public ObjectGridRuntimeException(Throwable cause)
Constructs a new ObjectGridRuntimeException 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 ObjectGridRuntimeExceptions 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.
See Also:
getCause()

ObjectGridRuntimeException

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

Note that the detail message associated with cause is not automatically incorporated in this ObjectGridRuntimeException'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).
See Also:
getCause(), Throwable.getMessage()
Method Detail

getCause

public Throwable getCause()
Returns the cause of this ObjectGridRuntimeException or null if the cause is nonexistent or unknown. (The cause is the throwable that caused this ObjectGridRuntimeException 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 an ObjectGridRuntimeException

Specified by:
getCause in interface IObjectGridException
Overrides:
getCause in class Throwable
Returns:
the cause of this ObjectGridRuntimeException or null if the cause is nonexistent or unknown.
See Also:
ObjectGridRuntimeException(String, Throwable), ObjectGridRuntimeException(Throwable), initCause(Throwable)

initCause

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

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

Specified by:
initCause in interface IObjectGridException
Overrides:
initCause in class Throwable
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 ObjectGridRuntimeException instance.
Throws:
IllegalArgumentException - if cause is this ObjectGridRuntimeException. (An ObjectGridRuntimeException cannot be its own cause.)
IllegalStateException - if this ObjectGridRuntimeException was created with ObjectGridRuntimeException(Throwable) or ObjectGridRuntimeException(String,Throwable), or this method has already been called on this ObjectGridRuntimeException.
See Also:
ObjectGridRuntimeException(String, Throwable), ObjectGridRuntimeException(Throwable), getCause()

IBM WebSphereTM eXtreme Scale, Release 8.6
API Specification

© Copyright International Business Machines Corp 2005,2012. All rights reserved.