com.googlecode.ehcache.annotations.CacheableAttribute Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ehcache-spring-annotations Show documentation

Provides a simple model for integrating Ehcache in a Spring project via annotations.

There is a newer version: 1.2.0

Show newest version

/**
 * Copyright 2010 Nicholas Blair, Eric Dalquist
 *
 * 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 com.googlecode.ehcache.annotations;

import net.sf.ehcache.Ehcache;

import org.aopalliance.intercept.MethodInvocation;

/**
 * Represents the objects needed to intercept calls to methods annotated
 * with {@link com.googlecode.ehcache.annotations.Cacheable}
 * 
 * @author Eric Dalquist
 * @version $Revision: 520 $
 */
public interface CacheableAttribute extends MethodAttribute {
    /**
     * @return The cache to use, will never be null.
     */
    public Ehcache getCache();
    
    /**
     * @return The cache to use in case of an exception, may be null if no exception caching should be done.
     */
    public Ehcache getExceptionCache();
    
    /**
     * @return The ThreadLocal to use with a self populating cache. If not null the intercepter must provide a {@link MethodInvocation} before calling {@link Ehcache#get(Object)}
     */
    public ThreadLocal getEntryFactory();
}