javax.cache.annotation.CacheKey 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-2013 Terracotta, Inc.
 *  Copyright (c) 2011-2013 Oracle and/or its affiliates.
 *
 *  All rights reserved. Use is subject to license terms.
 */

/**
 *  Copyright (c) 2011-2013-2013 Terracotta, Inc.
 *  Copyright (c) 2011-2013-2013 Oracle and/or its affiliates.
 *
 *  All rights reserved. Use is subject to license terms.
 */
package javax.cache.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;


/**
 * Marks a method argument as part of the cache key.
 * If no arguments are marked all arguments are used. The exception is
 * for a method annotated with {@link CachePut} where the {@link CacheValue}
 * parameter is never included in the key
 *
 * @author Rick Hightower
 * @see CacheResult
 * @see CachePut
 * @see CacheRemove
 * @see CacheKeyInvocationContext#getKeyParameters()
 * @since 1.0
 */
@Target({ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
public @interface CacheKey {

}