Skip to content

Commit 1ec7dd0

Browse files
committed
DATAGEODE-302 - Add appropriate Spring @nonnull and @nullable annotations to API.
Edit Javadoc.
1 parent 19238e0 commit 1ec7dd0

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

spring-data-geode/src/main/java/org/springframework/data/gemfire/support/ComposableCacheResolver.java

+13-9
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ public class ComposableCacheResolver<T extends GemFireCache> extends AbstractCac
4848
private final CacheResolver<T> cacheResolverTwo;
4949

5050
/**
51-
* Null-safe factory method to compose an array of {@link CacheResolver} objects in a composition.
51+
* Factory method used to compose an array of {@link CacheResolver CacheResolvers} in a composition.
5252
*
5353
* @param <T> {@link Class subclass} of {@link GemFireCache}.
5454
* @param cacheResolvers array of {@link CacheResolver CacheResolvers} to compose; may be {@literal null}.
@@ -63,14 +63,17 @@ public static <T extends GemFireCache> CacheResolver<T> compose(@Nullable CacheR
6363
}
6464

6565
/**
66-
* Null-safe factory method to compose an {@link Iterable} of {@link CacheResolver} objects in a composition.
66+
* Factory method used to compose an {@link Iterable} collection of {@link CacheResolver CacheResolvers}
67+
* in a composition.
6768
*
6869
* @param <T> {@link Class subclass} of {@link GemFireCache}.
69-
* @param cacheResolvers {@link Iterable} of {@link CacheResolver CacheResolvers} to compose; may be {@literal null}.
70-
* @return a composition from the {@link Iterable} of {@link CacheResolver CacheResolvers}; may be {@literal null}.
70+
* @param cacheResolvers {@link Iterable} collection of {@link CacheResolver CacheResolvers} to compose;
71+
* may be {@literal null}.
72+
* @return a composition from the {@link Iterable} collection of {@link CacheResolver CacheResolvers};
73+
* may be {@literal null}.
74+
* @see #compose(CacheResolver, CacheResolver)
7175
* @see org.springframework.data.gemfire.CacheResolver
7276
* @see java.lang.Iterable
73-
* @see #compose(CacheResolver, CacheResolver)
7477
*/
7578
@Nullable
7679
public static <T extends GemFireCache> CacheResolver<T> compose(@Nullable Iterable<CacheResolver<T>> cacheResolvers) {
@@ -105,14 +108,15 @@ public static <T extends GemFireCache> CacheResolver<T> compose(@Nullable CacheR
105108

106109
/**
107110
* Constructs a new instance of {@link ComposableCacheResolver} initialized and composed with
108-
* the given {@link CacheResolver} objects/arguments.
111+
* the given {@link CacheResolver CacheResolvers} forming the composition.
109112
*
110113
* @param cacheResolverOne first {@link CacheResolver} in the composition.
111114
* @param cacheResolverTwo second {@link CacheResolver} in the composition.
112115
* @throws IllegalArgumentException if either {@link CacheResolver} argument is {@literal null}.
113116
* @see org.springframework.data.gemfire.CacheResolver
114117
*/
115-
protected ComposableCacheResolver(CacheResolver<T> cacheResolverOne, CacheResolver<T> cacheResolverTwo) {
118+
protected ComposableCacheResolver(@NonNull CacheResolver<T> cacheResolverOne,
119+
@NonNull CacheResolver<T> cacheResolverTwo) {
116120

117121
Assert.notNull(cacheResolverOne, "CacheResolver 1 must not be null");
118122
Assert.notNull(cacheResolverTwo, "CacheResolver 2 must not be null");
@@ -137,13 +141,13 @@ protected ComposableCacheResolver(CacheResolver<T> cacheResolverOne, CacheResolv
137141
* @return a reference to the second {@link CacheResolver} in the composition.
138142
* @see org.springframework.data.gemfire.CacheResolver
139143
*/
140-
protected CacheResolver<T> getCacheResolverTwo() {
144+
protected @NonNull CacheResolver<T> getCacheResolverTwo() {
141145
return this.cacheResolverTwo;
142146
}
143147

144148
/**
145149
* Resolves the first, single reference to a {@link GemFireCache}, handling any {@link Exception Exceptions}
146-
* throwing by composed {@link CacheResolver CacheResolvers}, such as a {@link CacheClosedException}.
150+
* throwing by the composed {@link CacheResolver CacheResolvers}, such as a {@link CacheClosedException}.
147151
*
148152
* This method may ultimately still result in a thrown {@link Exception}, but it will make a best effort to
149153
* exhaustively consult all composed {@link CacheResolver CacheResolvers}.

0 commit comments

Comments
 (0)