Skip to content

Commit dcd8980

Browse files
committed
Formatting for Spec Doc.
1 parent c0fb841 commit dcd8980

File tree

4 files changed

+13
-15
lines changed

4 files changed

+13
-15
lines changed

Diff for: src/main/java/javax/cache/annotation/CachePut.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,8 @@
117117
/**
118118
* Defines zero (0) or more exception {@link Class classes}, that must be a
119119
* subclass of {@link Throwable}, indicating the exception types that <b>must</b>
120-
* cause the parameter to be cached. Only used if {@link #afterInvocation()} is true.
120+
* cause the parameter to be cached. Only used if {@link #afterInvocation()} is
121+
* true.
121122
*/
122123
@Nonbinding Class<? extends Throwable>[] cacheFor() default {};
123124

Diff for: src/main/java/javax/cache/annotation/CacheRemove.java

+4-7
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,8 @@
1919

2020
/**
2121
* When a method annotated with {@link CacheRemove} is invoked a {@link
22-
* GeneratedCacheKey} will be generated and
23-
* {@link Cache#remove(Object)} will be invoked on the specified
24-
* cache.
22+
* GeneratedCacheKey} will be generated and {@link Cache#remove(Object)} will be
23+
* invoked on the specified cache.
2524
* <p>
2625
* The default behavior is to call {@link Cache#remove(Object)} after
2726
* the annotated method is invoked, this behavior can be changed by setting
@@ -50,12 +49,10 @@
5049
* exceptions prevent the remove</li>
5150
* <li>If {@link #evictFor()} is specified and {@link #noEvictFor()} is not
5251
* specified then only exceptions that pass an instanceof check against the
53-
* evictFor list result in a
54-
* remove</li>
52+
* evictFor list result in a remove</li>
5553
* <li>If {@link #noEvictFor()} is specified and {@link #evictFor()} is not
5654
* specified then all exceptions that do not pass an instanceof check against the
57-
* noEvictFor result in a
58-
* remove</li>
55+
* noEvictFor result in a remove</li>
5956
* <li>If {@link #evictFor()} and {@link #noEvictFor()} are both specified then
6057
* exceptions that pass an instanceof check against the evictFor list but do not
6158
* pass an instanceof check against the noEvictFor list result in a remove</li>

Diff for: src/main/java/javax/cache/annotation/CacheRemoveAll.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,8 @@
105105
/**
106106
* Defines zero (0) or more exception {@link Class Classes}, that must be a
107107
* subclass of {@link Throwable}, indicating the exception types that must
108-
* <b>not</b> cause a cache eviction. Only used if {@link #afterInvocation()} is true.
108+
* <b>not</b> cause a cache eviction. Only used if {@link #afterInvocation()} is
109+
* true.
109110
*/
110111
@Nonbinding Class<? extends Throwable>[] noEvictFor() default {};
111112
}

Diff for: src/main/java/javax/cache/annotation/CacheResult.java

+5-6
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,11 @@
1818

1919
/**
2020
* When a method annotated with {@link CacheResult} is invoked a
21-
* {@link GeneratedCacheKey} will be generated and
22-
* {@link Cache#get(Object)} is called before the annotated method
23-
* actually executes. If a value is found in the cache it is returned and the
24-
* annotated method is never actually executed. If no value is found the
25-
* annotated method is invoked and the returned value is stored in the cache
26-
* with the generated key.
21+
* {@link GeneratedCacheKey} will be generated and {@link Cache#get(Object)} is
22+
* called before the annotated method actually executes. If a value is found in the
23+
* cache it is returned and the annotated method is never actually executed. If no
24+
* value is found the annotated method is invoked and the returned value is stored
25+
* in the cache with the generated key.
2726
* <p>
2827
* Exceptions are not cached by default. Caching of exceptions can be enabled by
2928
* specifying an {@link #exceptionCacheName()}. If an exception cache is specified

0 commit comments

Comments
 (0)