Spring/spring-data-redis
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Polishing.

Browse Source 
Tweak Javadoc wording for execute(…) with callback methods.

See #3049
Original pull request: #3055
This commit is contained in:
Mark Paluch
2024-11-28 08:40:25 +01:00
parent 3e16cc1bd5
commit 49f3f4e0d3
1 changed files with 14 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
src/main/java/org/springframework/data/redis/core/RedisOperations.java
View File

@@ -62,7 +62,7 @@ public interface RedisOperations<K, V> {
* *
* @param <T> return type * @param <T> return type
* @param action callback object that specifies the Redis action. Must not be {@literal null}. * @param action callback object that specifies the Redis action. Must not be {@literal null}.
* @return a result object returned by the action or {@literal null} * @return result of the given {@link RedisCallback#doInRedis(RedisConnection)} invocation.
*/ */
@Nullable @Nullable
<T> T execute(RedisCallback<T> action); <T> T execute(RedisCallback<T> action);
@@ -73,7 +73,7 @@ public interface RedisOperations<K, V> {
* *
* @param <T> return type * @param <T> return type
* @param session session callback. Must not be {@literal null}. * @param session session callback. Must not be {@literal null}.
* @return result object returned by the action or {@literal null} * @return result of the given {@link SessionCallback#execute(RedisOperations)} invocation.
*/ */
@Nullable @Nullable
<T> T execute(SessionCallback<T> session); <T> T execute(SessionCallback<T> session);
@@ -84,7 +84,9 @@ public interface RedisOperations<K, V> {
* serializers to deserialize results * serializers to deserialize results
* *
* @param action callback object to execute * @param action callback object to execute
* @return list of objects returned by the pipeline * @return pipeline results of the given {@link RedisCallback#doInRedis(RedisConnection)} invocation. Results are
* collected from {@link RedisConnection} calls, {@link RedisCallback#doInRedis(RedisConnection)} itself must
* return {@literal null}.
*/ */
List<Object> executePipelined(RedisCallback<?> action); List<Object> executePipelined(RedisCallback<?> action);
@@ -95,7 +97,9 @@ public interface RedisOperations<K, V> {
* @param action callback object to execute * @param action callback object to execute
* @param resultSerializer The Serializer to use for individual values or Collections of values. If any returned * @param resultSerializer The Serializer to use for individual values or Collections of values. If any returned
* values are hashes, this serializer will be used to deserialize both the key and value * values are hashes, this serializer will be used to deserialize both the key and value
* @return list of objects returned by the pipeline * @return pipeline results of the given {@link RedisCallback#doInRedis(RedisConnection)} invocation. Results are
* collected from {@link RedisConnection} calls, {@link RedisCallback#doInRedis(RedisConnection)} itself must
* return {@literal null}.
*/ */
List<Object> executePipelined(RedisCallback<?> action, RedisSerializer<?> resultSerializer); List<Object> executePipelined(RedisCallback<?> action, RedisSerializer<?> resultSerializer);
@@ -104,7 +108,9 @@ public interface RedisOperations<K, V> {
* callback <b>cannot</b> return a non-null value as it gets overwritten by the pipeline. * callback <b>cannot</b> return a non-null value as it gets overwritten by the pipeline.
* *
* @param session Session callback * @param session Session callback
* @return list of objects returned by the pipeline * @return pipeline results of the given {@link SessionCallback#execute(RedisOperations)} invocation. Results are
* collected from {@link RedisOperations} calls, {@link SessionCallback#execute(RedisOperations)} itself must
* return {@literal null}.
*/ */
List<Object> executePipelined(SessionCallback<?> session); List<Object> executePipelined(SessionCallback<?> session);
@@ -115,7 +121,9 @@ public interface RedisOperations<K, V> {
* *
* @param session Session callback * @param session Session callback
* @param resultSerializer * @param resultSerializer
* @return list of objects returned by the pipeline * @return pipeline results of the given {@link SessionCallback#execute(RedisOperations)} invocation. Results are
* collected from {@link RedisOperations} calls, {@link SessionCallback#execute(RedisOperations)} itself must
* return {@literal null}.
*/ */
List<Object> executePipelined(SessionCallback<?> session, RedisSerializer<?> resultSerializer); List<Object> executePipelined(SessionCallback<?> session, RedisSerializer<?> resultSerializer);