#231 Rename @CacheRemoveEntry to @CacheRemove

jsr107 · Aug 28, 2013 · 2df6fc7 · 2df6fc7
1 parent a182104
commit 2df6fc7
Show file tree

Hide file tree

Showing 7 changed files with 18 additions and 17 deletions.
diff --git a/src/main/java/javax/cache/annotation/CacheDefaults.java b/src/main/java/javax/cache/annotation/CacheDefaults.java
@@ -18,7 +18,7 @@
 
 /**
  * Allows the configuration of defaults for {@link CacheResult}, {@link CachePut},
- * {@link CacheRemoveEntry}, and {@link CacheRemoveAll} at the class level. Without
+ * {@link CacheRemove}, and {@link CacheRemoveAll} at the class level. Without
  * the method level annotations this annotation has no effect.
  * <p/>
  * Example of specifying a default cache name that is used by the annotations on the
@@ -34,7 +34,7 @@
  *     ...
  *   }
  * <p/>
- *   &#64;CacheRemoveEntry
+ *   &#64;CacheRemove
  *   public void deleteDomain(String domainId, int index) {
  *     ...
  *   }
@@ -58,7 +58,7 @@
    * <p/>
    * If not specified defaults to: package.name.ClassName.methodName(package.ParameterType,package.ParameterType)
    * <p/>
-   * Applicable for {@link CacheResult}, {@link CachePut}, {@link CacheRemoveEntry}, and {@link CacheRemoveAll}
+   * Applicable for {@link CacheResult}, {@link CachePut}, {@link CacheRemove}, and {@link CacheRemoveAll}
    */
   @Nonbinding String cacheName() default "";
 
@@ -67,7 +67,7 @@
    * <p/>
    * The default resolver pair will resolve the cache by name from the default {@link CacheManager}
    * <p/>
-   * Applicable for {@link CacheResult}, {@link CachePut}, {@link CacheRemoveEntry}, and {@link CacheRemoveAll}
+   * Applicable for {@link CacheResult}, {@link CachePut}, {@link CacheRemove}, and {@link CacheRemoveAll}
    */
   @Nonbinding Class<? extends CacheResolverFactory> cacheResolverFactory() default CacheResolverFactory.class;
 
@@ -79,7 +79,7 @@
    * {@link Arrays#deepEquals(Object[], Object[])} with the array returned by
    * {@link CacheKeyInvocationContext#getKeyParameters()}
    * <p/>
-   * Applicable for {@link CacheResult}, {@link CachePut}, and {@link CacheRemoveEntry}
+   * Applicable for {@link CacheResult}, {@link CachePut}, and {@link CacheRemove}
    *
    * @see CacheKey
    */

diff --git a/src/main/java/javax/cache/annotation/CacheInvocationContext.java b/src/main/java/javax/cache/annotation/CacheInvocationContext.java
@@ -11,15 +11,15 @@
 
 /**
  * Runtime information about an intercepted method invocation for a method
- * annotated with {@link CacheResult}, {@link CachePut}, {@link CacheRemoveEntry},
+ * annotated with {@link CacheResult}, {@link CachePut}, {@link CacheRemove},
  * or {@link CacheRemoveAll}
  * <p/>
  * Used with {@link CacheResolver#resolveCache(CacheInvocationContext)} to
  * determine the {@link javax.cache.Cache} to use at runtime for the method
  * invocation.
  *
  * @param <A> The type of annotation this context information is for. One of
- *            {@link CacheResult}, {@link CachePut}, {@link CacheRemoveEntry}, or {@link
+ *            {@link CacheResult}, {@link CachePut}, {@link CacheRemove}, or {@link
  *            CacheRemoveAll}.
  * @author Eric Dalquist
  * @see CacheResolver

diff --git a/src/main/java/javax/cache/annotation/CacheKey.java b/src/main/java/javax/cache/annotation/CacheKey.java
@@ -28,7 +28,7 @@
  * @author Rick Hightower
  * @see CacheResult
  * @see CachePut
- * @see CacheRemoveEntry
+ * @see CacheRemove
  * @see CacheKeyInvocationContext#getKeyParameters()
  * @since 1.0
  */

diff --git a/src/main/java/javax/cache/annotation/CacheKeyInvocationContext.java b/src/main/java/javax/cache/annotation/CacheKeyInvocationContext.java
@@ -12,13 +12,13 @@
 /**
  * Runtime information about an intercepted method invocation for a method
  * annotated with {@link CacheResult}, {@link CachePut}, or
- * {@link CacheRemoveEntry}.
+ * {@link CacheRemove}.
  * <p/>
  * Used with {@link CacheKeyGenerator#generateCacheKey(CacheKeyInvocationContext)}
  * to generate a {@link GeneratedCacheKey} for the invocation.
  *
  * @param <A> The type of annotation this context information is for. One of
- *            {@link CacheResult}, {@link CachePut}, or {@link CacheRemoveEntry}.
+ *            {@link CacheResult}, {@link CachePut}, or {@link CacheRemove}.
  * @author Eric Dalquist
  * @see CacheKeyGenerator
  */

diff --git a/src/main/java/javax/cache/annotation/CacheMethodDetails.java b/src/main/java/javax/cache/annotation/CacheMethodDetails.java
@@ -14,14 +14,14 @@
 
 /**
  * Static information about a method annotated with one of:
- * {@link CacheResult}, {@link CachePut}, {@link CacheRemoveEntry}, or {@link
+ * {@link CacheResult}, {@link CachePut}, {@link CacheRemove}, or {@link
  * CacheRemoveAll}
  * <p/>
  * Used with {@link CacheResolverFactory#getCacheResolver(CacheMethodDetails)} to
  * determine the {@link CacheResolver} to use with the method.
  *
  * @param <A> The type of annotation this context information is for. One of
- *            {@link CacheResult}, {@link CachePut}, {@link CacheRemoveEntry}, or
+ *            {@link CacheResult}, {@link CachePut}, {@link CacheRemove}, or
  *            {@link CacheRemoveAll}.
  * @author Eric Dalquist
  * @see CacheResolverFactory
@@ -43,7 +43,7 @@ public interface CacheMethodDetails<A extends Annotation> {
 
   /**
    * The caching related annotation on the method.
-   * One of: {@link CacheResult}, {@link CachePut}, {@link CacheRemoveEntry}, or
+   * One of: {@link CacheResult}, {@link CachePut}, {@link CacheRemove}, or
    * {@link CacheRemoveAll}
    *
    * @return The caching related annotation on the method.

diff --git a/...ax/cache/annotation/CacheRemoveEntry.java → ...a/javax/cache/annotation/CacheRemove.java b/...ax/cache/annotation/CacheRemoveEntry.java → ...a/javax/cache/annotation/CacheRemove.java
@@ -18,7 +18,7 @@
 
 
 /**
- * When a method annotated with {@link CacheRemoveEntry} is invoked a {@link
+ * When a method annotated with {@link CacheRemove} is invoked a {@link
  * GeneratedCacheKey} will be generated and
  * {@link Cache#remove(Object)} will be invoked on the specified
  * cache.
@@ -37,7 +37,7 @@
  * package my.app;
  * <p/>
  * public class DomainDao {
- *   &#64;CacheRemoveEntry(cacheName="domainCache")
+ *   &#64;CacheRemove(cacheName="domainCache")
  *   public void deleteDomain(String domainId, int index) {
  *     ...
  *   }
@@ -62,12 +62,13 @@
  *
  * @author Eric Dalquist
  * @author Rick Hightower
+ * @author Greg Luck
  * @see CacheKey
  * @since 1.0
  */
 @Target({ElementType.METHOD, ElementType.TYPE})
 @Retention(RetentionPolicy.RUNTIME)
-public @interface CacheRemoveEntry {
+public @interface CacheRemove {
 
   /**
    * The name of the cache.

diff --git a/src/main/java/javax/cache/annotation/CacheResolverFactory.java b/src/main/java/javax/cache/annotation/CacheResolverFactory.java
@@ -25,7 +25,7 @@ public interface CacheResolverFactory {
   /**
    * Get the {@link CacheResolver} used at runtime for resolution of the
    * {@link Cache} for the {@link CacheResult}, {@link CachePut},
-   * {@link CacheRemoveEntry}, or {@link CacheRemoveAll} annotation.
+   * {@link CacheRemove}, or {@link CacheRemoveAll} annotation.
    *
    * @param cacheMethodDetails The details of the annotated method to get the
    *                           {@link CacheResolver} for. @return The {@link