DATAREDIS-680 - Polishing.

Add author tag. Adopt javadoc fix in other affected operations and connection interfaces.

Original pull request: #265.
This commit is contained in:
Mark Paluch
2017-08-25 12:16:37 +02:00
parent 646e068c8d
commit 6513e77f7d
5 changed files with 20 additions and 18 deletions

View File

@@ -23,7 +23,7 @@ import org.springframework.util.Assert;
/**
* ZSet(SortedSet)-specific commands supported by Redis.
*
*
* @author Costin Leau
* @author Christoph Strobl
* @author Thomas Darimont
@@ -51,7 +51,7 @@ public interface RedisZSetCommands {
/**
* {@link Range} defines {@literal min} and {@literal max} values to retrieve from a {@literal ZSET}.
*
*
* @author Christoph Strobl
* @since 1.6
*/
@@ -80,7 +80,7 @@ public interface RedisZSetCommands {
/**
* Greater Than Equals
*
*
* @param min
* @return
*/
@@ -93,7 +93,7 @@ public interface RedisZSetCommands {
/**
* Greater Than
*
*
* @param min
* @return
*/
@@ -106,7 +106,7 @@ public interface RedisZSetCommands {
/**
* Less Then Equals
*
*
* @param max
* @return
*/
@@ -119,7 +119,7 @@ public interface RedisZSetCommands {
/**
* Less Than
*
*
* @param max
* @return
*/
@@ -304,7 +304,7 @@ public interface RedisZSetCommands {
/**
* Get set of {@link Tuple}s where score is between {@code Range#min} and {@code Range#max} from sorted set.
*
*
* @param key must not be {@literal null}.
* @param range must not be {@literal null}.
* @return
@@ -365,7 +365,7 @@ public interface RedisZSetCommands {
/**
* Get set of {@link Tuple}s in range from {@code Limit#offset} to {@code Limit#offset + Limit#count} where score is
* between {@code Range#min} and {@code Range#max} from sorted set.
*
*
* @param key must not be {@literal null}.
* @param range must not be {@literal null}.
* @param limit
@@ -413,7 +413,7 @@ public interface RedisZSetCommands {
/**
* Get elements where score is between {@code Range#min} and {@code Range#max} from sorted set ordered from high to
* low.
*
*
* @param key must not be {@literal null}.
* @param range must not be {@literal null}.
* @return
@@ -549,17 +549,17 @@ public interface RedisZSetCommands {
/**
* Get the score of element with {@code value} from sorted set with key {@code key}.
*
*
* @param key must not be {@literal null}.
* @param value the value.
* @return
* @see <a href="http://redis.io/commands/zrem">Redis Documentation: ZREM</a>
* @see <a href="http://redis.io/commands/zscore">Redis Documentation: ZSCORE</a>
*/
Double zScore(byte[] key, byte[] value);
/**
* Remove elements in range between {@code start} and {@code end} from sorted set with {@code key}.
*
*
* @param key must not be {@literal null}.
* @param start
* @param end

View File

@@ -1189,7 +1189,7 @@ public interface StringRedisConnection extends RedisConnection {
* @param key must not be {@literal null}.
* @param value the value.
* @return
* @see <a href="http://redis.io/commands/zrem">Redis Documentation: ZREM</a>
* @see <a href="http://redis.io/commands/zscore">Redis Documentation: ZSCORE</a>
* @see RedisZSetCommands#zScore(byte[], byte[])
*/
Double zScore(String key, String value);

View File

@@ -25,7 +25,7 @@ import org.springframework.data.redis.core.ZSetOperations.TypedTuple;
/**
* ZSet (or SortedSet) operations bound to a certain key.
*
*
* @author Costin Leau
* @author Christoph Strobl
* @author Mark Paluch
@@ -202,7 +202,7 @@ public interface BoundZSetOperations<K, V> extends BoundKeyOperations<K> {
*
* @param o the value.
* @return
* @see <a href="http://redis.io/commands/zrem">Redis Documentation: ZREM</a>
* @see <a href="http://redis.io/commands/zscore">Redis Documentation: ZSCORE</a>
*/
Double score(Object o);

View File

@@ -251,7 +251,7 @@ public interface ReactiveZSetOperations<K, V> {
* @param key must not be {@literal null}.
* @param o the value.
* @return
* @see <a href="http://redis.io/commands/zrem">Redis Documentation: ZREM</a>
* @see <a href="http://redis.io/commands/zscore">Redis Documentation: ZSCORE</a>
*/
Mono<Double> score(K key, Object o);

View File

@@ -24,17 +24,18 @@ import org.springframework.data.redis.connection.RedisZSetCommands.Tuple;
/**
* Redis ZSet/sorted set specific operations.
*
*
* @author Costin Leau
* @author Christoph Strobl
* @author Mark Paluch
* @author Rosty Kerei
*/
public interface ZSetOperations<K, V> {
/**
* Typed ZSet tuple.
*/
public interface TypedTuple<V> extends Comparable<TypedTuple<V>> {
interface TypedTuple<V> extends Comparable<TypedTuple<V>> {
V getValue();
Double getScore();
@@ -361,6 +362,7 @@ public interface ZSetOperations<K, V> {
* @param key
* @param options
* @return
* @see <a href="http://redis.io/commands/zscan">Redis Documentation: ZSCAN</a>
* @since 1.4
*/
Cursor<TypedTuple<V>> scan(K key, ScanOptions options);