com.ibm.websphere.objectgrid
Class ObjectGridException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          com.ibm.websphere.objectgrid.ObjectGridException

All Implemented Interfaces:

IObjectGridException, Serializable

Direct Known Subclasses:

CacheEntryException, CatalogNetworkPartitioningException, ConnectException, ContinuousQueryException, DeploymentPolicyException, DuplicateKeyException, DuplicateNameException, FinderException, IndexAlreadyDefinedException, IndexNotReadyException, IndexUndefinedException, KeyNotFoundException, LoaderException, LockException, NoActiveTransactionException, ObjectGridConfigurationException, ObjectGridSecurityException, OptimisticCollisionException, ReadOnlyException, ReconnectException, ServiceNotAvailableException, ServiceUpdateException, TransactionCallbackException, TransactionException, UndefinedMapException, ZoneConfigurationException

public class ObjectGridException
extends Exception
implements IObjectGridException

Base exception class for all checked exceptions thrown by the ObjectGrid product.

Since:

WAS XD 6.0, XC10

See Also:

Serialized Form

Constructor Summary

ObjectGridException()
Constructs a new ObjectGridException with null as its detail message.

ObjectGridException(String message)
Constructs a new ObjectGridException with the specified detail message.

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

ObjectGridException(Throwable cause)
Constructs a new ObjectGridException with a specified cause.

Method Summary

Throwable	getCause() Returns the cause of this ObjectGridException or null if the cause is nonexistent or unknown.
Throwable	initCause(Throwable cause) Initializes the cause of this ObjectGridException 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

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 the initCause method.

See Also:

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 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()

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.

See Also:

getCause()

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).

See Also:

getCause(), Throwable.getMessage()

Method Detail

getCause

public Throwable getCause()

Returns the cause of this ObjectGridException or null if the cause is nonexistent or unknown. (The cause is the throwable that caused this ObjectGridException 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 ObjectGridException

Specified by:

getCause in interface IObjectGridException

Overrides:

getCause in class Throwable

Returns:

the cause of this ObjectGridException or null if the cause is nonexistent or unknown.

See Also:

ObjectGridException(String, Throwable), ObjectGridException(Throwable), initCause(Throwable)

initCause

public Throwable initCause(Throwable cause)

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

This method can be called at most once. It is generally called from within the constructor, or immediately after creating the ObjectGridException. If this ObjectGridException was created with ObjectGridException(Throwable) or ObjectGridException(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 ObjectGridException instance.

Throws:

IllegalArgumentException - if cause is this ObjectGridException. (An ObjectGridException cannot be its own cause.)

IllegalStateException - if this ObjectGridException was created with ObjectGridException(Throwable) or ObjectGridException(String,Throwable), or this method has already been called on this ObjectGridException.

See Also:

ObjectGridException(String, Throwable), ObjectGridException(Throwable), getCause()