javax.cache.annotation.CacheResolverFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cache-api

There is a newer version: 1.1.1

/**
 *  Copyright (c) 2011 Terracotta, Inc.
 *  Copyright (c) 2011 Oracle and/or its affiliates.
 *
 *  All rights reserved. Use is subject to license terms.
 */


package javax.cache.annotation;

import java.lang.annotation.Annotation;

/**
 * Determines the {@link CacheResolver} to use for an annotated method. The {@link CacheResolver} will be retrieved
 * once per annotated method.
 * 
 * Implementations MUST be thread-safe.
 * 
 * @author Eric Dalquist
 * @since 1.0
 */
public interface CacheResolverFactory {

    /**
     * Get the {@link CacheResolver} used at runtime for resolution of the {@link javax.cache.Cache} for the
     * {@link CacheResult}, {@link CachePut}, {@link CacheRemoveEntry}, or {@link CacheRemoveAll}
     * annotation.
     * 
     * @param cacheMethodDetails The details of the annotated method to get the {@link CacheResolver} for.
     * @return The {@link CacheResolver} instance to be used by the intercepter.
     */
    CacheResolver getCacheResolver(CacheMethodDetails cacheMethodDetails);
    
    /**
     * Get the {@link CacheResolver} used at runtime for resolution of the {@link javax.cache.Cache} for the
     * {@link CacheResult} annotation to cache exceptions.
     * 
     * Will only be called if {@link CacheResult#exceptionCacheName()} is not empty.
     * 
     * @param cacheMethodDetails The details of the annotated method to get the {@link CacheResolver} for.
     * @return The {@link CacheResolver} instance to be used by the intercepter.
     */
    CacheResolver getExceptionCacheResolver(CacheMethodDetails cacheMethodDetails);
}