javax.cache.annotation.impl.CacheContextSource Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cache-annotations-ri-common Show documentation
The newest version!
/**
 *  Copyright 2011 Terracotta, Inc.
 *  Copyright 2011 Oracle America Incorporated
 *
 *  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 javax.cache.annotation.impl;

import java.lang.annotation.Annotation;
import java.lang.reflect.Method;



/**
 * Defines API for looking up information about an invocation.
 * 
 * @author Eric Dalquist
 * @param  The intercepted method invocation
 * @since 1.0
 */
public interface CacheContextSource {
    /**
     * Placeholder used for caching a null value
     */
    NullPlaceholder NULL_PLACEHOLDER = NullPlaceholder.INSTANCE;
    
    /**
     * Get information about an invocation annotated {@link javax.cache.annotation.CacheResult}, 
     * {@link javax.cache.annotation.CachePut}, or {@link javax.cache.annotation.CacheRemoveEntry}
     * 
     * @param invocation The intercepted invocation
     * @return Information about the invocation
     */
    InternalCacheKeyInvocationContext getCacheKeyInvocationContext(I invocation);
    
    /**
     * Get information about an invocation annotated {@link javax.cache.annotation.CacheResult}, 
     * {@link javax.cache.annotation.CachePut}, {@link javax.cache.annotation.CacheRemoveEntry},
     * or {@link javax.cache.annotation.CacheRemoveAll}
     * 
     * @param invocation The intercepted invocation
     * @return Information about the invocation
     */
    InternalCacheInvocationContext getCacheInvocationContext(I invocation);
    
    /**
     * Get static information about a method annotated with {@link javax.cache.annotation.CacheResult}, 
     * {@link javax.cache.annotation.CachePut}, {@link javax.cache.annotation.CacheRemoveEntry},
     * or {@link javax.cache.annotation.CacheRemoveAll}
     * 
     * @param method The annotated method
     * @param targetClass The Class that will be targeted with invocations
     * @return Static information about the annotated method
     */
    StaticCacheInvocationContext getMethodDetails(Method method, Class targetClass);

    
    /**
     * Used to cache null values, there should never be more than the single INSTANCE
     */
    public enum NullPlaceholder {
        /**
         * Null Placeholder for use with {@link javax.cache.CachePut} and {@link javax.cache.CacheResult}
         */
        INSTANCE;
    }
}