Polishing.

Update Bound operations parameter documentation order. Tweak wording.

See #2214
This commit is contained in:
Mark Paluch
2022-03-10 13:51:48 +01:00
parent 3cf420a8d4
commit 69205c56bb
3 changed files with 18 additions and 18 deletions

View File

@@ -45,8 +45,8 @@ public interface BoundZSetOperations<K, V> extends BoundKeyOperations<K> {
/**
* Add {@code value} to a sorted set at the bound key, or update its {@code score} if it already exists.
*
* @param score the score.
* @param value the value.
* @param score the score.
* @return {@literal null} when used in pipeline / transaction.
* @see <a href="https://redis.io/commands/zadd">Redis Documentation: ZADD</a>
*/
@@ -56,8 +56,8 @@ public interface BoundZSetOperations<K, V> extends BoundKeyOperations<K> {
/**
* Add {@code value} to a sorted set at the bound key if it does not already exists.
*
* @param score the score.
* @param value the value.
* @param score the score.
* @return {@literal null} when used in pipeline / transaction.
* @since 2.5
* @see <a href="https://redis.io/commands/zadd">Redis Documentation: ZADD NX</a>
@@ -99,8 +99,8 @@ public interface BoundZSetOperations<K, V> extends BoundKeyOperations<K> {
/**
* Increment the score of element with {@code value} in sorted set by {@code increment}.
*
* @param delta
* @param value the value.
* @param delta the delta to add. Can be negative.
* @return {@literal null} when used in pipeline / transaction.
* @see <a href="https://redis.io/commands/zincrby">Redis Documentation: ZINCRBY</a>
*/
@@ -119,7 +119,7 @@ public interface BoundZSetOperations<K, V> extends BoundKeyOperations<K> {
/**
* Get {@code count} distinct random elements from set at the bound key.
*
* @param count nr of members to return
* @param count number of members to return.
* @return empty {@link Set} if {@code key} does not exist.
* @throws IllegalArgumentException if count is negative.
* @since 2.6
@@ -131,7 +131,7 @@ public interface BoundZSetOperations<K, V> extends BoundKeyOperations<K> {
/**
* Get {@code count} random elements from set at the bound key.
*
* @param count nr of members to return.
* @param count number of members to return.
* @return empty {@link List} if {@code key} does not exist or {@literal null} when used in pipeline / transaction.
* @throws IllegalArgumentException if count is negative.
* @since 2.6
@@ -152,7 +152,7 @@ public interface BoundZSetOperations<K, V> extends BoundKeyOperations<K> {
/**
* Get {@code count} distinct random elements with their score from set at the bound key.
*
* @param count nr of members to return
* @param count number of members to return.
* @return empty {@link Set} if {@code key} does not exist.
* @throws IllegalArgumentException if count is negative.
* @since 2.6
@@ -164,7 +164,7 @@ public interface BoundZSetOperations<K, V> extends BoundKeyOperations<K> {
/**
* Get {@code count} random elements with their score from set at the bound key.
*
* @param count nr of members to return.
* @param count number of members to return.
* @return empty {@link List} if {@code key} does not exist or {@literal null} when used in pipeline / transaction.
* @throws IllegalArgumentException if count is negative.
* @since 2.6

View File

@@ -45,8 +45,8 @@ public interface ReactiveZSetOperations<K, V> {
* Add {@code value} to a sorted set at {@code key}, or update its {@code score} if it already exists.
*
* @param key must not be {@literal null}.
* @param score the score.
* @param value the value.
* @param score the score.
* @return
* @see <a href="https://redis.io/commands/zadd">Redis Documentation: ZADD</a>
*/
@@ -76,8 +76,8 @@ public interface ReactiveZSetOperations<K, V> {
* Increment the score of element with {@code value} in sorted set by {@code increment}.
*
* @param key must not be {@literal null}.
* @param delta
* @param value the value.
* @param delta the delta to add. Can be negative.
* @return
* @see <a href="https://redis.io/commands/zincrby">Redis Documentation: ZINCRBY</a>
*/
@@ -97,7 +97,7 @@ public interface ReactiveZSetOperations<K, V> {
* Get {@code count} distinct random elements from set at {@code key}.
*
* @param key must not be {@literal null}.
* @param count nr of members to return
* @param count number of members to return.
* @return
* @throws IllegalArgumentException if count is negative.
* @since 2.6
@@ -109,7 +109,7 @@ public interface ReactiveZSetOperations<K, V> {
* Get {@code count} random elements from set at {@code key}.
*
* @param key must not be {@literal null}.
* @param count nr of members to return.
* @param count number of members to return.
* @return
* @throws IllegalArgumentException if count is negative.
* @since 2.6
@@ -131,7 +131,7 @@ public interface ReactiveZSetOperations<K, V> {
* Get {@code count} distinct random elements with their score from set at {@code key}.
*
* @param key must not be {@literal null}.
* @param count nr of members to return
* @param count number of members to return.
* @return
* @throws IllegalArgumentException if count is negative.
* @since 2.6
@@ -143,7 +143,7 @@ public interface ReactiveZSetOperations<K, V> {
* Get {@code count} random elements with their score from set at {@code key}.
*
* @param key must not be {@literal null}.
* @param count nr of members to return.
* @param count number of members to return.
* @return
* @throws IllegalArgumentException if count is negative.
* @since 2.6

View File

@@ -131,7 +131,7 @@ public interface ZSetOperations<K, V> {
*
* @param key must not be {@literal null}.
* @param value the value.
* @param delta
* @param delta the delta to add. Can be negative.
* @return {@literal null} when used in pipeline / transaction.
* @see <a href="https://redis.io/commands/zincrby">Redis Documentation: ZINCRBY</a>
*/
@@ -152,7 +152,7 @@ public interface ZSetOperations<K, V> {
* Get {@code count} distinct random elements from set at {@code key}.
*
* @param key must not be {@literal null}.
* @param count nr of members to return
* @param count number of members to return.
* @return empty {@link Set} if {@code key} does not exist.
* @throws IllegalArgumentException if count is negative.
* @since 2.6
@@ -165,7 +165,7 @@ public interface ZSetOperations<K, V> {
* Get {@code count} random elements from set at {@code key}.
*
* @param key must not be {@literal null}.
* @param count nr of members to return.
* @param count number of members to return.
* @return empty {@link List} if {@code key} does not exist or {@literal null} when used in pipeline / transaction.
* @throws IllegalArgumentException if count is negative.
* @since 2.6
@@ -188,7 +188,7 @@ public interface ZSetOperations<K, V> {
* Get {@code count} distinct random elements with their score from set at {@code key}.
*
* @param key must not be {@literal null}.
* @param count nr of members to return
* @param count number of members to return.
* @return empty {@link Set} if {@code key} does not exist.
* @throws IllegalArgumentException if count is negative.
* @since 2.6
@@ -201,7 +201,7 @@ public interface ZSetOperations<K, V> {
* Get {@code count} random elements with their score from set at {@code key}.
*
* @param key must not be {@literal null}.
* @param count nr of members to return.
* @param count number of members to return.
* @return empty {@link List} if {@code key} does not exist or {@literal null} when used in pipeline / transaction.
* @throws IllegalArgumentException if count is negative.
* @since 2.6