net.sf.ehcache
Class CacheException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          java.lang.RuntimeException
              net.sf.ehcache.CacheException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CacheWriterManagerException, ClusterSchemeNotAvailableException, InvalidConfigurationException, LoaderTimeoutException, LockTimeoutException, NonStopCacheException, ObjectExistsException, RejoinCacheException, RemoteCacheException, SearchException, TerracottaNotRunningException, TransactionException

public class CacheException
extends RuntimeException

A runtime Cache Exception.

These exceptions may be handled by a CacheExceptionHandler registered with a Cache. The handler provides a key if it is available. A convention that should be followed in exception messages is to include in the message "key keyValue" e.g. "key 1234" so that keys can be parsed out of exception messages.

Updated in version 1.5 to remove getInitialCause which was a left over from the pre-JDK1.4 days. It breaks JAXB.

Version:

$Id: CacheException.java 5594 2012-05-07 16:04:31Z cdennis $

Author:

Greg Luck

See Also:

Serialized Form

Constructor Summary

CacheException()
Constructor for the CacheException object.

CacheException(String message)
Constructor for the CacheException object.

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

CacheException(Throwable cause)
Constructs a new CacheException with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).

Method Summary

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CacheException

public CacheException()

Constructor for the CacheException object.

CacheException

public CacheException(String message)

Constructor for the CacheException object.

Parameters:

message - the exception detail message

CacheException

public CacheException(String message,
                      Throwable cause)

Constructs a new CacheException with the specified detail message and cause.

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

Parameters:

message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).

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

Since:

1.2.4

CacheException

public CacheException(Throwable cause)

Constructs a new CacheException with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause). This constructor is useful for runtime exceptions that are little more than wrappers for other throwables.

Parameters:

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

Since:

1.2.4