Skip to content

Commit 49f3f4e

Browse files
committed
Polishing.
Tweak Javadoc wording for execute(…) with callback methods. See #3049 Original pull request: #3055
1 parent 3e16cc1 commit 49f3f4e

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

src/main/java/org/springframework/data/redis/core/RedisOperations.java

+14-6
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ public interface RedisOperations<K, V> {
6262
*
6363
* @param <T> return type
6464
* @param action callback object that specifies the Redis action. Must not be {@literal null}.
65-
* @return a result object returned by the action or {@literal null}
65+
* @return result of the given {@link RedisCallback#doInRedis(RedisConnection)} invocation.
6666
*/
6767
@Nullable
6868
<T> T execute(RedisCallback<T> action);
@@ -73,7 +73,7 @@ public interface RedisOperations<K, V> {
7373
*
7474
* @param <T> return type
7575
* @param session session callback. Must not be {@literal null}.
76-
* @return result object returned by the action or {@literal null}
76+
* @return result of the given {@link SessionCallback#execute(RedisOperations)} invocation.
7777
*/
7878
@Nullable
7979
<T> T execute(SessionCallback<T> session);
@@ -84,7 +84,9 @@ public interface RedisOperations<K, V> {
8484
* serializers to deserialize results
8585
*
8686
* @param action callback object to execute
87-
* @return list of objects returned by the pipeline
87+
* @return pipeline results of the given {@link RedisCallback#doInRedis(RedisConnection)} invocation. Results are
88+
* collected from {@link RedisConnection} calls, {@link RedisCallback#doInRedis(RedisConnection)} itself must
89+
* return {@literal null}.
8890
*/
8991
List<Object> executePipelined(RedisCallback<?> action);
9092

@@ -95,7 +97,9 @@ public interface RedisOperations<K, V> {
9597
* @param action callback object to execute
9698
* @param resultSerializer The Serializer to use for individual values or Collections of values. If any returned
9799
* values are hashes, this serializer will be used to deserialize both the key and value
98-
* @return list of objects returned by the pipeline
100+
* @return pipeline results of the given {@link RedisCallback#doInRedis(RedisConnection)} invocation. Results are
101+
* collected from {@link RedisConnection} calls, {@link RedisCallback#doInRedis(RedisConnection)} itself must
102+
* return {@literal null}.
99103
*/
100104
List<Object> executePipelined(RedisCallback<?> action, RedisSerializer<?> resultSerializer);
101105

@@ -104,7 +108,9 @@ public interface RedisOperations<K, V> {
104108
* callback <b>cannot</b> return a non-null value as it gets overwritten by the pipeline.
105109
*
106110
* @param session Session callback
107-
* @return list of objects returned by the pipeline
111+
* @return pipeline results of the given {@link SessionCallback#execute(RedisOperations)} invocation. Results are
112+
* collected from {@link RedisOperations} calls, {@link SessionCallback#execute(RedisOperations)} itself must
113+
* return {@literal null}.
108114
*/
109115
List<Object> executePipelined(SessionCallback<?> session);
110116

@@ -115,7 +121,9 @@ public interface RedisOperations<K, V> {
115121
*
116122
* @param session Session callback
117123
* @param resultSerializer
118-
* @return list of objects returned by the pipeline
124+
* @return pipeline results of the given {@link SessionCallback#execute(RedisOperations)} invocation. Results are
125+
* collected from {@link RedisOperations} calls, {@link SessionCallback#execute(RedisOperations)} itself must
126+
* return {@literal null}.
119127
*/
120128
List<Object> executePipelined(SessionCallback<?> session, RedisSerializer<?> resultSerializer);
121129

0 commit comments

Comments
 (0)