net.sf.ehcache.CacheException Maven / Gradle / Ivy
Show all versions of ehcache-core Show documentation
/**
* Copyright 2003-2010 Terracotta, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package net.sf.ehcache;
/**
* 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 3046 2010-10-26 07:41:34Z gluck $
*
*/
public class CacheException extends RuntimeException {
private static final long serialVersionUID = 142468800110101833L;
/**
* Constructor for the CacheException object.
*/
public CacheException() {
super();
}
/**
* Constructor for the CacheException object.
* @param message the exception detail message
*/
public CacheException(String message) {
super(message);
}
/**
* 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.
*
* @param message the detail message (which is saved for later retrieval
* by the {@link #getMessage()} method).
* @param cause the cause (which is saved for later retrieval by the
* {@link #getCause()} method). (A null value is
* permitted, and indicates that the cause is nonexistent or
* unknown.)
* @since 1.2.4
*/
public CacheException(String message, Throwable cause) {
super(message, 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.
*
* @param cause the cause (which is saved for later retrieval by the
* {@link #getCause()} method). (A null value is
* permitted, and indicates that the cause is nonexistent or
* unknown.)
* @since 1.2.4
*/
public CacheException(Throwable cause) {
super(cause);
}
}