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

Go to download

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

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;

/**
 * Generates a {@link CacheKey} based on a {@link CacheKeyInvocationContext}.
 * 
 * Implementations MUST be thread-safe.
 *
 * @author Eric Dalquist
 * @since 1.0
 */
public interface CacheKeyGenerator {

    /**
     * Called for each intercepted method invocation. Generate a {@link CacheKey} from the {@link CacheKeyInvocationContext} data.
     *
     * @param cacheKeyInvocationContext Information about the intercepted method invocation
     * @return A non-null cache key for the invocation.
     */
    CacheKey generateCacheKey(CacheKeyInvocationContext cacheKeyInvocationContext);
}