Top Description Fields Constructors
net.sf.ehcache

public Class CacheException

extends RuntimeException
Class Inheritance
Known Direct Subclasses
net.sf.ehcache.LoaderTimeoutException, net.sf.ehcache.ObjectExistsException, net.sf.ehcache.cluster.ClusterSchemeNotAvailableException, net.sf.ehcache.config.InvalidConfigurationException, net.sf.ehcache.constructs.blocking.LockTimeoutException, net.sf.ehcache.constructs.nonstop.NonStopCacheException, net.sf.ehcache.constructs.nonstop.RejoinCacheException, net.sf.ehcache.distribution.RemoteCacheException, net.sf.ehcache.search.SearchException, net.sf.ehcache.terracotta.TerracottaNotRunningException, net.sf.ehcache.transaction.TransactionException, net.sf.ehcache.writer.CacheWriterManagerException
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.

Author
Greg Luck
Version
$Id: CacheException.java 10789 2018-04-26 02:08:13Z adahanne $

Field Summary

Modifier and TypeField and Description
private static final long
serialVersionUID

Hides java.lang.RuntimeException.serialVersionUID.

Constructor Summary

AccessConstructor and Description
public
CacheException()

Constructor for the CacheException object.

public
CacheException(String
the exception detail message
message)

Constructor for the CacheException object.

public
CacheException(String
the detail message (which is saved for later retrieval by the getMessage() method).
message, Throwable
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.)
cause)

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

public
CacheException(Throwable
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.)
cause)

Constructs a new CacheException with the specified cause and a detail message of (cause==null ?

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides java.lang.RuntimeException.serialVersionUID.

Constructor Detail

CacheExceptionback to summary
public CacheException()

Constructor for the CacheException object.

CacheExceptionback to summary
public CacheException(String message)

Constructor for the CacheException object.

Parameters
message:String

the exception detail message

CacheExceptionback to summary
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:String

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

cause:Throwable

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

Since
1.2.4
CacheExceptionback to summary
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:Throwable

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

Since
1.2.4