DATAREDIS-359 - Fix redis javadoc generation.

This commit is contained in:
Thomas Darimont
2014-11-27 23:11:26 +01:00
parent cb070c1375
commit 7ea72f3682
7 changed files with 263 additions and 142 deletions

View File

@@ -39,10 +39,10 @@ import org.springframework.util.CollectionUtils;
/**
* {@link CacheManager} implementation for Redis. By default saves the keys directly, without appending a prefix (which
* acts as a namespace). To avoid clashes, it is recommended to change this (by setting 'usePrefix' to 'true'). <br/>
* acts as a namespace). To avoid clashes, it is recommended to change this (by setting 'usePrefix' to 'true'). <br>
* By default {@link RedisCache}s will be lazily initialized for each {@link #getCache(String)} request unless a set of
* predefined cache names is provided. <br />
* <br />
* predefined cache names is provided. <br>
* <br>
* Setting {@link #setTransactionAware(boolean)} to {@code true} will force Caches to be decorated as
* {@link TransactionAwareCacheDecorator} so values will only be written to the cache after successful commit of
* surrounding transaction.
@@ -101,7 +101,7 @@ public class RedisCacheManager extends AbstractTransactionSupportingCacheManager
}
/**
* Specify the set of cache names for this CacheManager's 'static' mode. <br/>
* Specify the set of cache names for this CacheManager's 'static' mode. <br>
* The number of caches and their names will be fixed after a call to this method, with no creation of further cache
* regions at runtime.
*/

View File

@@ -31,8 +31,9 @@ public interface RedisKeyCommands {
/**
* Determine if given {@code key} exists.
* <p>
* See http://redis.io/commands/exists
*
* @see http://redis.io/commands/exists
* @param key
* @return
*/
@@ -40,8 +41,9 @@ public interface RedisKeyCommands {
/**
* Delete given {@code keys}.
* <p>
* See http://redis.io/commands/del
*
* @see http://redis.io/commands/del
* @param keys
* @return The number of keys that were removed.
*/
@@ -49,8 +51,9 @@ public interface RedisKeyCommands {
/**
* Determine the type stored at {@code key}.
* <p>
* See http://redis.io/commands/type
*
* @see http://redis.io/commands/type
* @param key
* @return
*/
@@ -58,19 +61,20 @@ public interface RedisKeyCommands {
/**
* Find all keys matching the given {@code pattern}.
* <p>
* See http://redis.io/commands/keys
*
* @see http://redis.io/commands/keys
* @param pattern
* @return
*/
Set<byte[]> keys(byte[] pattern);
/**
* Use a {@link Cursor} to iterate over keys. <br />
* Use a {@link Cursor} to iterate over keys.
* <p>
* See http://redis.io/commands/scan
*
* @see http://redis.io/commands/scan
* @param count
* @param pattern
* @param options
* @return
* @since 1.4
*/
@@ -78,16 +82,18 @@ public interface RedisKeyCommands {
/**
* Return a random key from the keyspace.
* <p>
* See http://redis.io/commands/randomkey
*
* @see http://redis.io/commands/randomkey
* @return
*/
byte[] randomKey();
/**
* Rename key {@code oleName} to {@code newName}.
* <p>
* See http://redis.io/commands/rename
*
* @see http://redis.io/commands/rename
* @param oldName
* @param newName
*/
@@ -95,8 +101,9 @@ public interface RedisKeyCommands {
/**
* Rename key {@code oleName} to {@code newName} only if {@code newName} does not exist.
* <p>
* See http://redis.io/commands/renamenx
*
* @see http://redis.io/commands/renamenx
* @param oldName
* @param newName
* @return
@@ -105,8 +112,9 @@ public interface RedisKeyCommands {
/**
* Set time to live for given {@code key} in seconds.
* <p>
* See http://redis.io/commands/expire
*
* @see http://redis.io/commands/expire
* @param key
* @param seconds
* @return
@@ -115,8 +123,9 @@ public interface RedisKeyCommands {
/**
* Set time to live for given {@code key} in milliseconds.
* <p>
* See http://redis.io/commands/pexpire
*
* @see http://redis.io/commands/pexpire
* @param key
* @param millis
* @return
@@ -125,8 +134,9 @@ public interface RedisKeyCommands {
/**
* Set the expiration for given {@code key} as a {@literal UNIX} timestamp.
* <p>
* See http://redis.io/commands/expireat
*
* @see http://redis.io/commands/expireat
* @param key
* @param unixTime
* @return
@@ -135,8 +145,9 @@ public interface RedisKeyCommands {
/**
* Set the expiration for given {@code key} as a {@literal UNIX} timestamp in milliseconds.
* <p>
* See http://redis.io/commands/pexpireat
*
* @see http://redis.io/commands/pexpireat
* @param key
* @param unixTimeInMillis
* @return
@@ -145,8 +156,9 @@ public interface RedisKeyCommands {
/**
* Remove the expiration from given {@code key}.
* <p>
* See http://redis.io/commands/persist
*
* @see http://redis.io/commands/persist
* @param key
* @return
*/
@@ -154,8 +166,9 @@ public interface RedisKeyCommands {
/**
* Move given {@code key} to database with {@code index}.
* <p>
* See http://redis.io/commands/move
*
* @see http://redis.io/commands/move
* @param key
* @param dbIndex
* @return
@@ -164,8 +177,9 @@ public interface RedisKeyCommands {
/**
* Get the time to live for {@code key} in seconds.
* <p>
* See http://redis.io/commands/ttl
*
* @see http://redis.io/commands/ttl
* @param key
* @return
*/
@@ -173,8 +187,9 @@ public interface RedisKeyCommands {
/**
* Get the time to live for {@code key} in milliseconds.
* <p>
* See http://redis.io/commands/pttl
*
* @see http://redis.io/commands/pttl
* @param key
* @return
*/
@@ -182,8 +197,9 @@ public interface RedisKeyCommands {
/**
* Sort the elements for {@code key}.
* <p>
* See http://redis.io/commands/sort
*
* @see http://redis.io/commands/sort
* @param key
* @param params
* @return
@@ -192,8 +208,9 @@ public interface RedisKeyCommands {
/**
* Sort the elements for {@code key} and store result in {@code storeKey}.
* <p>
* See http://redis.io/commands/sort
*
* @see http://redis.io/commands/sort
* @param key
* @param params
* @param storeKey
@@ -203,8 +220,9 @@ public interface RedisKeyCommands {
/**
* Retrieve serialized version of the value stored at {@code key}.
* <p>
* See http://redis.io/commands/dump
*
* @see http://redis.io/commands/dump
* @param key
* @return
*/
@@ -212,8 +230,9 @@ public interface RedisKeyCommands {
/**
* Create {@code key} using the {@code serializedValue}, previously obtained using {@link #dump(byte[])}.
* <p>
* See http://redis.io/commands/restore
*
* @see http://redis.io/commands/restore
* @param key
* @param ttlInMillis
* @param serializedValue

View File

@@ -34,8 +34,9 @@ public interface RedisListCommands {
/**
* Append {@code values} to {@code key}.
* <p>
* See http://redis.io/commands/rpush
*
* @see http://redis.io/commands/rpush
* @param key
* @param values
* @return
@@ -44,28 +45,31 @@ public interface RedisListCommands {
/**
* Prepend {@code values} to {@code key}.
* <p>
* See http://redis.io/commands/lpush
*
* @see http://redis.io/commands/lpush
* @param key
* @param value
* @param values
* @return
*/
Long lPush(byte[] key, byte[]... value);
Long lPush(byte[] key, byte[]... values);
/**
* Append {@code} values to {@code key} only if the list exists.
* <p>
* See http://redis.io/commands/rpushx
*
* @see http://redis.io/commands/rpushx
* @param key
* @param values
* @param value
* @return
*/
Long rPushX(byte[] key, byte[] value);
/**
* Prepend {@code values} to {@code key} only if the list exits.
* Prepend {@code values} to {@code key} only if the list exists.
* <p>
* See http://redis.io/commands/lpushx
*
* @see http://redis.io/commands/lpushx
* @param key
* @param value
* @return
@@ -74,8 +78,9 @@ public interface RedisListCommands {
/**
* Get the size of list stored at {@code key}.
* <p>
* See http://redis.io/commands/llen
*
* @see http://redis.io/commands/llen
* @param key
* @return
*/
@@ -83,8 +88,9 @@ public interface RedisListCommands {
/**
* Get elements between {@code begin} and {@code end} from list at {@code key}.
* <p>
* See http://redis.io/commands/lrange
*
* @see http://redis.io/commands/lrange
* @param key
* @param begin
* @param end
@@ -94,8 +100,9 @@ public interface RedisListCommands {
/**
* Trim list at {@code key} to elements between {@code begin} and {@code end}.
* <p>
* See http://redis.io/commands/ltrim
*
* @see http://redis.io/commands/ltrim
* @param key
* @param begin
* @param end
@@ -104,8 +111,9 @@ public interface RedisListCommands {
/**
* Get element at {@code index} form list at {@code key}.
* <p>
* See http://redis.io/commands/lindex
*
* @see http://redis.io/commands/lindex
* @param key
* @param index
* @return
@@ -114,8 +122,9 @@ public interface RedisListCommands {
/**
* Insert {@code value} {@link Position#BEFORE} or {@link Position#AFTER} existing {@code pivot} for {@code key}.
* <p>
* See http://redis.io/commands/linsert
*
* @see http://redis.io/commands/linsert
* @param key
* @param where
* @param pivot
@@ -126,8 +135,9 @@ public interface RedisListCommands {
/**
* Set the {@code value} list element at {@code index}.
* <p>
* See http://redis.io/commands/lset
*
* @see http://redis.io/commands/lset
* @param key
* @param index
* @param value
@@ -136,8 +146,9 @@ public interface RedisListCommands {
/**
* Removes the first {@code count} occurrences of {@code value} from the list stored at {@code key}.
* <p>
* See http://redis.io/commands/lrem
*
* @see http://redis.io/commands/lrem
* @param key
* @param count
* @param value
@@ -147,8 +158,9 @@ public interface RedisListCommands {
/**
* Removes and returns first element in list stored at {@code key}.
* <p>
* See http://redis.io/commands/lpop
*
* @see http://redis.io/commands/lpop
* @param key
* @return
*/
@@ -156,18 +168,20 @@ public interface RedisListCommands {
/**
* Removes and returns last element in list stored at {@code key}.
* <p>
* See http://redis.io/commands/rpop
*
* @see http://redis.io/commands/rpop
* @param key
* @return
*/
byte[] rPop(byte[] key);
/**
* Removes and returns first element from lists stored at {@code keys} (see: {@link #lPop(byte[])}). <br />
* Removes and returns first element from lists stored at {@code keys} (see: {@link #lPop(byte[])}). <br>
* <b>Blocks connection</b> until element available or {@code timeout} reached.
* <p>
* See http://redis.io/commands/blpop
*
* @see http://redis.io/commands/blpop
* @param timeout
* @param keys
* @return
@@ -175,10 +189,11 @@ public interface RedisListCommands {
List<byte[]> bLPop(int timeout, byte[]... keys);
/**
* Removes and returns last element from lists stored at {@code keys} (see: {@link #rPop(byte[])}). <br />
* Removes and returns last element from lists stored at {@code keys} (see: {@link #rPop(byte[])}). <br>
* <b>Blocks connection</b> until element available or {@code timeout} reached.
* <p>
* See http://redis.io/commands/brpop
*
* @see http://redis.io/commands/brpop
* @param timeout
* @param keys
* @return
@@ -187,8 +202,9 @@ public interface RedisListCommands {
/**
* Remove the last element from list at {@code srcKey}, append it to {@code dstKey} and return its value.
* <p>
* See http://redis.io/commands/rpoplpush
*
* @see http://redis.io/commands/rpoplpush
* @param srcKey
* @param dstKey
* @return
@@ -197,10 +213,11 @@ public interface RedisListCommands {
/**
* Remove the last element from list at {@code srcKey}, append it to {@code dstKey} and return its value (see
* {@link #rPopLPush(byte[], byte[])}). <br />
* {@link #rPopLPush(byte[], byte[])}). <br>
* <b>Blocks connection</b> until element available or {@code timeout} reached.
* <p>
* See http://redis.io/commands/brpoplpush
*
* @see http://redis.io/commands/brpoplpush
* @param timeout
* @param srcKey
* @param dstKey

View File

@@ -31,8 +31,9 @@ public interface RedisSetCommands {
/**
* Add given {@code values} to set at {@code key}.
* <p>
* See http://redis.io/commands/sadd
*
* @see http://redis.io/commands/sadd
* @param key
* @param values
* @return
@@ -41,8 +42,9 @@ public interface RedisSetCommands {
/**
* Remove given {@code values} from set at {@code key} and return the number of removed elements.
* <p>
* See http://redis.io/commands/srem
*
* @see http://redis.io/commands/srem
* @param key
* @param values
* @return
@@ -51,8 +53,9 @@ public interface RedisSetCommands {
/**
* Remove and return a random member from set at {@code key}.
* <p>
* See http://redis.io/commands/spop
*
* @see http://redis.io/commands/spop
* @param key
* @return
*/
@@ -60,8 +63,9 @@ public interface RedisSetCommands {
/**
* Move {@code value} from {@code srcKey} to {@destKey}
* <p>
* See http://redis.io/commands/smove
*
* @see http://redis.io/commands/smove
* @param srcKey
* @param destKey
* @param value
@@ -71,8 +75,9 @@ public interface RedisSetCommands {
/**
* Get size of set at {@code key}.
* <p>
* See http://redis.io/commands/scard
*
* @see http://redis.io/commands/scard
* @param key
* @return
*/
@@ -80,8 +85,9 @@ public interface RedisSetCommands {
/**
* Check if set at {@code key} contains {@code value}.
* <p>
* See http://redis.io/commands/sismember
*
* @see http://redis.io/commands/sismember
* @param key
* @param value
* @return
@@ -90,8 +96,9 @@ public interface RedisSetCommands {
/**
* Returns the members intersecting all given sets at {@code keys}.
* <p>
* See http://redis.io/commands/sinter
*
* @see http://redis.io/commands/sinter
* @param keys
* @return
*/
@@ -99,8 +106,9 @@ public interface RedisSetCommands {
/**
* Intersect all given sets at {@code keys} and store result in {@code destKey}.
* <p>
* See http://redis.io/commands/sinterstore
*
* @see http://redis.io/commands/sinterstore
* @param destKey
* @param keys
* @return
@@ -109,8 +117,9 @@ public interface RedisSetCommands {
/**
* Union all sets at given {@code keys}.
* <p>
* See http://redis.io/commands/sunion
*
* @see http://redis.io/commands/sunion
* @param keys
* @return
*/
@@ -118,8 +127,10 @@ public interface RedisSetCommands {
/**
* Union all sets at given {@code keys} and store result in {@code destKey}.
* <p>
* See http://redis.io/commands/sunionstore
*
* @see http://redis.io/commands/sunionstore
* @param destKey
* @param keys
* @return
*/
@@ -127,8 +138,9 @@ public interface RedisSetCommands {
/**
* Diff all sets for given {@code keys}.
* <p>
* See http://redis.io/commands/sdiff
*
* @see http://redis.io/commands/sdiff
* @param keys
* @return
*/
@@ -136,8 +148,10 @@ public interface RedisSetCommands {
/**
* Diff all sets for given {@code keys} and store result in {@code destKey}
* <p>
* See http://redis.io/commands/sdiffstore
*
* @see http://redis.io/commands/sdiffstore
* @param destKey
* @param keys
* @return
*/
@@ -145,8 +159,9 @@ public interface RedisSetCommands {
/**
* Get all elements of set at {@code key}.
* <p>
* See http://redis.io/commands/smembers
*
* @see http://redis.io/commands/smembers
* @param key
* @return
*/
@@ -154,8 +169,9 @@ public interface RedisSetCommands {
/**
* Get random element from set at {@code key}.
* <p>
* See http://redis.io/commands/srandmember
*
* @see http://redis.io/commands/srandmember
* @param key
* @return
*/
@@ -163,18 +179,21 @@ public interface RedisSetCommands {
/**
* Get {@code count} random elements from set at {@code key}.
* <p>
* See http://redis.io/commands/srandmember
*
* @see http://redis.io/commands/srandmember
* @param key
* @param count
* @return
*/
List<byte[]> sRandMember(byte[] key, long count);
/**
* Use a {@link Cursor} to iterate over elements in set at {@code key}.
* <p>
* See http://redis.io/commands/scan
*
* @since 1.4
* @see http://redis.io/commands/scan
* @param key
* @param options
* @return

View File

@@ -32,8 +32,9 @@ public interface RedisStringCommands {
/**
* Get the value of {@code key}.
* <p>
* See http://redis.io/commands/get
*
* @see http://redis.io/commands/get
* @param key
* @return
*/
@@ -41,8 +42,9 @@ public interface RedisStringCommands {
/**
* Set value of {@code key} and return its old value.
* <p>
* See http://redis.io/commands/getset
*
* @see http://redis.io/commands/getset
* @param key
* @param value
* @return
@@ -51,8 +53,9 @@ public interface RedisStringCommands {
/**
* Get the values of all given {@code keys}.
* <p>
* See http://redis.io/commands/mget
*
* @see http://redis.io/commands/mget
* @param keys
* @return
*/
@@ -60,8 +63,9 @@ public interface RedisStringCommands {
/**
* Set {@code value} for {@code key}.
* <p>
* See http://redis.io/commands/set
*
* @see http://redis.io/commands/set
* @param key
* @param value
*/
@@ -69,8 +73,9 @@ public interface RedisStringCommands {
/**
* Set {@code value} for {@code key}, only if {@code key} does not exist.
* <p>
* See http://redis.io/commands/setnx
*
* @see http://redis.io/commands/setnx
* @param key
* @param value
* @return
@@ -79,8 +84,9 @@ public interface RedisStringCommands {
/**
* Set the {@code value} and expiration in {@code seconds} for {@code key}.
* <p>
* See http://redis.io/commands/setex
*
* @see http://redis.io/commands/setex
* @param key
* @param seconds
* @param value
@@ -89,8 +95,9 @@ public interface RedisStringCommands {
/**
* Set the {@code value} and expiration in {@code milliseconds} for {@code key}.
* <p>
* See http://redis.io/commands/psetex
*
* @see http://redis.io/commands/psetex
* @param key
* @param milliseconds
* @param value
@@ -100,8 +107,9 @@ public interface RedisStringCommands {
/**
* Set multiple keys to multiple values using key-value pairs provided in {@code tuple}.
* <p>
* See http://redis.io/commands/mset
*
* @see http://redis.io/commands/mset
* @param tuple
*/
void mSet(Map<byte[], byte[]> tuple);
@@ -109,16 +117,18 @@ public interface RedisStringCommands {
/**
* Set multiple keys to multiple values using key-value pairs provided in {@code tuple} only if the provided key does
* not exist.
* <p>
* See http://redis.io/commands/msetnx
*
* @see http://redis.io/commands/msetnx
* @param tuple
*/
Boolean mSetNX(Map<byte[], byte[]> tuple);
/**
* Increment value of {@code key} by 1.
* <p>
* See http://redis.io/commands/incr
*
* @see http://redis.io/commands/incr
* @param key
* @return
*/
@@ -126,26 +136,31 @@ public interface RedisStringCommands {
/**
* Increment value of {@code key} by {@code value}.
* <p>
* See http://redis.io/commands/incrby
*
* @see http://redis.io/commands/incrby
* @param key
* @param value
* @return
*/
Long incrBy(byte[] key, long value);
/**
* Increment value of {@code key} by {@code value}.
* <p>
* See http://redis.io/commands/incrbyfloat
*
* @see http://redis.io/commands/incrbyfloat
* @param key
* @param value
* @return
*/
Double incrBy(byte[] key, double value);
/**
* Decrement value of {@code key} by 1.
* <p>
* See http://redis.io/commands/decr
*
* @see http://redis.io/commands/decr
* @param key
* @return
*/
@@ -153,8 +168,9 @@ public interface RedisStringCommands {
/**
* Increment value of {@code key} by {@code value}.
* <p>
* See http://redis.io/commands/decrby
*
* @see http://redis.io/commands/decrby
* @param key
* @param value
* @return
@@ -163,8 +179,9 @@ public interface RedisStringCommands {
/**
* Append a {@code value} to {@code key}.
* <p>
* See http://redis.io/commands/append
*
* @see http://redis.io/commands/append
* @param key
* @param value
* @return
@@ -173,8 +190,9 @@ public interface RedisStringCommands {
/**
* Get a substring of value of {@code key} between {@code begin} and {@code end}.
* <p>
* See http://redis.io/commands/getrange
*
* @see http://redis.io/commands/getrange
* @param key
* @param begin
* @param end
@@ -184,8 +202,9 @@ public interface RedisStringCommands {
/**
* Overwrite parts of {@code key} starting at the specified {@code offset} with given {@code value}.
* <p>
* See http://redis.io/commands/setrange
*
* @see http://redis.io/commands/setrange
* @param key
* @param value
* @param offset
@@ -194,8 +213,9 @@ public interface RedisStringCommands {
/**
* Get the bit value at {@code offset} of value at {@code key}.
* <p>
* See http://redis.io/commands/getbit
*
* @see http://redis.io/commands/getbit
* @param key
* @param offset
* @return
@@ -204,8 +224,9 @@ public interface RedisStringCommands {
/**
* Sets the bit at {@code offset} in value stored at {@code key}.
* <p>
* See http://redis.io/commands/setbit
*
* @see http://redis.io/commands/setbit
* @param key
* @param offset
* @param value
@@ -215,8 +236,9 @@ public interface RedisStringCommands {
/**
* Count the number of set bits (population counting) in value stored at {@code key}.
* <p>
* See http://redis.io/commands/bitcount
*
* @see http://redis.io/commands/bitcount
* @param key
* @return
*/
@@ -225,8 +247,9 @@ public interface RedisStringCommands {
/**
* Count the number of set bits (population counting) of value stored at {@code key} between {@code begin} and
* {@code end}.
* <p>
* See http://redis.io/commands/bitcount
*
* @see http://redis.io/commands/bitcount
* @param key
* @param begin
* @param end
@@ -236,8 +259,9 @@ public interface RedisStringCommands {
/**
* Perform bitwise operations between strings.
* <p>
* See http://redis.io/commands/bitop
*
* @see http://redis.io/commands/bitop
* @param op
* @param destination
* @param keys
@@ -247,8 +271,9 @@ public interface RedisStringCommands {
/**
* Get the length of the value stored at {@code key}.
* <p>
* See http://redis.io/commands/strlen
*
* @see http://redis.io/commands/strlen
* @param key
* @return
*/

View File

@@ -41,6 +41,7 @@ public interface RedisZSetCommands {
* ZSet tuple.
*/
public interface Tuple extends Comparable<Double> {
byte[] getValue();
Double getScore();
@@ -48,8 +49,9 @@ public interface RedisZSetCommands {
/**
* Add {@code value} to a sorted set at {@code key}, or update its {@code score} if it already exists.
* <p>
* See http://redis.io/commands/zadd
*
* @see http://redis.io/commands/zadd
* @param key
* @param score
* @param value
@@ -59,8 +61,9 @@ public interface RedisZSetCommands {
/**
* Add {@code tuples} to a sorted set at {@code key}, or update its {@code score} if it already exists.
* <p>
* See http://redis.io/commands/zadd
*
* @see http://redis.io/commands/zadd
* @param key
* @param tuples
* @return
@@ -69,8 +72,9 @@ public interface RedisZSetCommands {
/**
* Remove {@code values} from sorted set. Return number of removed elements.
* <p>
* See http://redis.io/commands/zrem
*
* @see http://redis.io/commands/zrem
* @param key
* @param values
* @return
@@ -79,8 +83,9 @@ public interface RedisZSetCommands {
/**
* Increment the score of element with {@code value} in sorted set by {@code increment}.
* <p>
* See http://redis.io/commands/zincrby
*
* @see http://redis.io/commands/zincrby
* @param key
* @param increment
* @param value
@@ -90,8 +95,9 @@ public interface RedisZSetCommands {
/**
* Determine the index of element with {@code value} in a sorted set.
* <p>
* See http://redis.io/commands/zrank
*
* @see http://redis.io/commands/zrank
* @param key
* @param value
* @return
@@ -100,8 +106,9 @@ public interface RedisZSetCommands {
/**
* Determine the index of element with {@code value} in a sorted set when scored high to low.
* <p>
* See http://redis.io/commands/zrevrank
*
* @see http://redis.io/commands/zrevrank
* @param key
* @param value
* @return
@@ -110,8 +117,9 @@ public interface RedisZSetCommands {
/**
* Get elements between {@code begin} and {@code end} from sorted set.
* <p>
* See http://redis.io/commands/zrange
*
* @see http://redis.io/commands/zrange
* @param key
* @param begin
* @param end
@@ -121,8 +129,9 @@ public interface RedisZSetCommands {
/**
* Get set of {@link Tuple}s between {@code begin} and {@code end} from sorted set.
* <p>
* See http://redis.io/commands/zrange
*
* @see http://redis.io/commands/zrange
* @param key
* @param begin
* @param end
@@ -132,22 +141,24 @@ public interface RedisZSetCommands {
/**
* Get elements where score is between {@code min} and {@code max} from sorted set.
* <p>
* See http://redis.io/commands/zrangebyscore
*
* @see http://redis.io/commands/zrangebyscore
* @param key
* @param begin
* @param end
* @param min
* @param max
* @return
*/
Set<byte[]> zRangeByScore(byte[] key, double min, double max);
/**
* Get set of {@link Tuple}s where score is between {@code min} and {@code max} from sorted set.
* <p>
* See http://redis.io/commands/zrangebyscore
*
* @see http://redis.io/commands/zrangebyscore
* @param key
* @param begin
* @param end
* @param min
* @param max
* @return
*/
Set<Tuple> zRangeByScoreWithScores(byte[] key, double min, double max);
@@ -155,11 +166,14 @@ public interface RedisZSetCommands {
/**
* Get elements in range from {@code begin} to {@code end} where score is between {@code min} and {@code max} from
* sorted set.
* <p>
* See http://redis.io/commands/zrangebyscore
*
* @see http://redis.io/commands/zrangebyscore
* @param key
* @param begin
* @param end
* @param min
* @param max
* @param offset
* @param count
* @return
*/
Set<byte[]> zRangeByScore(byte[] key, double min, double max, long offset, long count);
@@ -167,19 +181,23 @@ public interface RedisZSetCommands {
/**
* Get set of {@link Tuple}s in range from {@code begin} to {@code end} where score is between {@code min} and
* {@code max} from sorted set.
* <p>
* See http://redis.io/commands/zrangebyscore
*
* @see http://redis.io/commands/zrangebyscore
* @param key
* @param begin
* @param end
* @param min
* @param max
* @param offset
* @param count
* @return
*/
Set<Tuple> zRangeByScoreWithScores(byte[] key, double min, double max, long offset, long count);
/**
* Get elements in range from {@code begin} to {@code end} from sorted set ordered high -> low.
* <p>
* See http://redis.io/commands/zrevrange
*
* @see http://redis.io/commands/zrevrange
* @param key
* @param begin
* @param end
@@ -189,8 +207,9 @@ public interface RedisZSetCommands {
/**
* Get set of {@link Tuple}s in range from {@code begin} to {@code end} from sorted set ordered high -> low.
* <p>
* See http://redis.io/commands/zrevrange
*
* @see http://redis.io/commands/zrevrange
* @param key
* @param begin
* @param end
@@ -200,22 +219,24 @@ public interface RedisZSetCommands {
/**
* Get elements where score is between {@code min} and {@code max} from sorted set ordered high -> low.
* <p>
* See http://redis.io/commands/zrevrange
*
* @see http://redis.io/commands/zrevrange
* @param key
* @param begin
* @param end
* @param min
* @param max
* @return
*/
Set<byte[]> zRevRangeByScore(byte[] key, double min, double max);
/**
* Get set of {@link Tuple} where score is between {@code min} and {@code max} from sorted set ordered high -> low.
* <p>
* See http://redis.io/commands/zrevrange
*
* @see http://redis.io/commands/zrevrange
* @param key
* @param begin
* @param end
* @param min
* @param max
* @return
*/
Set<Tuple> zRevRangeByScoreWithScores(byte[] key, double min, double max);
@@ -223,11 +244,14 @@ public interface RedisZSetCommands {
/**
* Get elements in range from {@code begin} to {@code end} where score is between {@code min} and {@code max} from
* sorted set ordered high -> low.
* <p>
* See http://redis.io/commands/zrevrangebyscore
*
* @see http://redis.io/commands/zrevrangebyscore
* @param key
* @param begin
* @param end
* @param min
* @param max
* @param offset
* @param count
* @return
*/
Set<byte[]> zRevRangeByScore(byte[] key, double min, double max, long offset, long count);
@@ -235,19 +259,23 @@ public interface RedisZSetCommands {
/**
* Get set of {@link Tuple} in range from {@code begin} to {@code end} where score is between {@code min} and
* {@code max} from sorted set ordered high -> low.
* <p>
* See http://redis.io/commands/zrevrangebyscore
*
* @see http://redis.io/commands/zrevrangebyscore
* @param key
* @param begin
* @param end
* @param min
* @param max
* @param offset
* @param count
* @return
*/
Set<Tuple> zRevRangeByScoreWithScores(byte[] key, double min, double max, long offset, long count);
/**
* Count number of elements within sorted set with scores between {@code min} and {@code max}.
* <p>
* See http://redis.io/commands/zcount
*
* @see http://redis.io/commands/zcount
* @param key
* @param min
* @param max
@@ -257,8 +285,9 @@ public interface RedisZSetCommands {
/**
* Get the size of sorted set with {@code key}.
* <p>
* See http://redis.io/commands/zcard
*
* @see http://redis.io/commands/zcard
* @param key
* @return
*/
@@ -266,8 +295,9 @@ public interface RedisZSetCommands {
/**
* Get the score of element with {@code value} from sorted set with key {@code key}.
* <p>
* See http://redis.io/commands/zrem
*
* @see http://redis.io/commands/zrem
* @param key
* @param value
* @return
@@ -276,8 +306,9 @@ public interface RedisZSetCommands {
/**
* Remove elements in range between {@code begin} and {@code end} from sorted set with {@code key}.
* <p>
* See http://redis.io/commands/zremrange
*
* @see http://redis.io/commands/zremrange
* @param key
* @param begin
* @param end
@@ -287,8 +318,9 @@ public interface RedisZSetCommands {
/**
* Remove elements with scores between {@code min} and {@code max} from sorted set with {@code key}.
* <p>
* See http://redis.io/commands/zremrangebyscore
*
* @see http://redis.io/commands/zremrangebyscore
* @param key
* @param min
* @param max
@@ -298,8 +330,9 @@ public interface RedisZSetCommands {
/**
* Union sorted {@code sets} and store result in destination {@code key}.
* <p>
* See http://redis.io/commands/zunionstore
*
* @see http://redis.io/commands/zunionstore
* @param destKey
* @param sets
* @return
@@ -308,8 +341,9 @@ public interface RedisZSetCommands {
/**
* Union sorted {@code sets} and store result in destination {@code key}.
* <p>
* See http://redis.io/commands/zunionstore
*
* @see http://redis.io/commands/zunionstore
* @param destKey
* @param aggregate
* @param weights
@@ -320,8 +354,9 @@ public interface RedisZSetCommands {
/**
* Intersect sorted {@code sets} and store result in destination {@code key}.
* <p>
* See http://redis.io/commands/zinterstore
*
* @see http://redis.io/commands/zinterstore
* @param destKey
* @param sets
* @return
@@ -330,8 +365,9 @@ public interface RedisZSetCommands {
/**
* Intersect sorted {@code sets} and store result in destination {@code key}.
* <p>
* See http://redis.io/commands/zinterstore
*
* @see http://redis.io/commands/zinterstore
* @param destKey
* @param sets
* @return
@@ -340,23 +376,25 @@ public interface RedisZSetCommands {
/**
* Use a {@link Cursor} to iterate over elements in sorted set at {@code key}.
* <p>
* See http://redis.io/commands/scan
*
* @since 1.4
* @see http://redis.io/commands/scan
* @param key
* @param options
* @return
*/
Cursor<Tuple> zScan(byte[] key, ScanOptions options);
/**
* Get elements where score is between {@code min} and {@code max} from sorted set.
* <p>
* See http://redis.io/commands/zrangebyscore
*
* @since 1.5
* @see http://redis.io/commands/zrangebyscore
* @param key
* @param begin
* @param end
* @param min
* @param max
* @return
*/
Set<byte[]> zRangeByScore(byte[] key, String min, String max);
@@ -364,12 +402,15 @@ public interface RedisZSetCommands {
/**
* Get elements in range from {@code begin} to {@code end} where score is between {@code min} and {@code max} from
* sorted set.
* <p>
* See http://redis.io/commands/zrangebyscore
*
* @since 1.5
* @see http://redis.io/commands/zrangebyscore
* @param key
* @param begin
* @param end
* @param min
* @param max
* @param offset
* @param count
* @return
*/
Set<byte[]> zRangeByScore(byte[] key, String min, String max, long offset, long count);

View File

@@ -1,6 +1,6 @@
/**
* Root package for integrating <a href="http://code.google.com/p/redis/">Redis</a> with Spring concepts.
* <p/>
* <p>
* Provides Redis specific exception hierarchy on top of the {@code org.springframework.dao} package.
*
*/