Java tutorial
/* * Copyright 2011-2019 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * https://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package org.springframework.data.redis.core; import java.util.Collection; import java.util.Set; import org.springframework.data.redis.connection.RedisZSetCommands.Aggregate; import org.springframework.data.redis.connection.RedisZSetCommands.Limit; import org.springframework.data.redis.connection.RedisZSetCommands.Range; import org.springframework.data.redis.connection.RedisZSetCommands.Tuple; import org.springframework.data.redis.connection.RedisZSetCommands.Weights; import org.springframework.lang.Nullable; /** * Redis ZSet/sorted set specific operations. * * @author Costin Leau * @author Christoph Strobl * @author Mark Paluch * @author Rosty Kerei * @author Wongoo () */ public interface ZSetOperations<K, V> { /** * Typed ZSet tuple. */ interface TypedTuple<V> extends Comparable<TypedTuple<V>> { @Nullable V getValue(); @Nullable Double getScore(); } /** * 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. * @return {@literal null} when used in pipeline / transaction. * @see <a href="https://redis.io/commands/zadd">Redis Documentation: ZADD</a> */ @Nullable Boolean add(K key, V value, double score); /** * Add {@code tuples} to a sorted set at {@code key}, or update its {@code score} if it already exists. * * @param key must not be {@literal null}. * @param tuples must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @see <a href="https://redis.io/commands/zadd">Redis Documentation: ZADD</a> */ @Nullable Long add(K key, Set<TypedTuple<V>> tuples); /** * Remove {@code values} from sorted set. Return number of removed elements. * * @param key must not be {@literal null}. * @param values must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @see <a href="https://redis.io/commands/zrem">Redis Documentation: ZREM</a> */ @Nullable Long remove(K key, Object... values); /** * 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. * @return {@literal null} when used in pipeline / transaction. * @see <a href="https://redis.io/commands/zincrby">Redis Documentation: ZINCRBY</a> */ @Nullable Double incrementScore(K key, V value, double delta); /** * Determine the index of element with {@code value} in a sorted set. * * @param key must not be {@literal null}. * @param o the value. * @return {@literal null} when used in pipeline / transaction. * @see <a href="https://redis.io/commands/zrank">Redis Documentation: ZRANK</a> */ @Nullable Long rank(K key, Object o); /** * Determine the index of element with {@code value} in a sorted set when scored high to low. * * @param key must not be {@literal null}. * @param o the value. * @return {@literal null} when used in pipeline / transaction. * @see <a href="https://redis.io/commands/zrevrank">Redis Documentation: ZREVRANK</a> */ @Nullable Long reverseRank(K key, Object o); /** * Get elements between {@code start} and {@code end} from sorted set. * * @param key must not be {@literal null}. * @param start * @param end * @return {@literal null} when used in pipeline / transaction. * @see <a href="https://redis.io/commands/zrange">Redis Documentation: ZRANGE</a> */ @Nullable Set<V> range(K key, long start, long end); /** * Get set of {@link Tuple}s between {@code start} and {@code end} from sorted set. * * @param key must not be {@literal null}. * @param start * @param end * @return {@literal null} when used in pipeline / transaction. * @see <a href="https://redis.io/commands/zrange">Redis Documentation: ZRANGE</a> */ @Nullable Set<TypedTuple<V>> rangeWithScores(K key, long start, long end); /** * Get elements where score is between {@code min} and {@code max} from sorted set. * * @param key must not be {@literal null}. * @param min * @param max * @return {@literal null} when used in pipeline / transaction. * @see <a href="https://redis.io/commands/zrangebyscore">Redis Documentation: ZRANGEBYSCORE</a> */ @Nullable Set<V> rangeByScore(K key, double min, double max); /** * Get set of {@link Tuple}s where score is between {@code min} and {@code max} from sorted set. * * @param key must not be {@literal null}. * @param min * @param max * @return {@literal null} when used in pipeline / transaction. * @see <a href="https://redis.io/commands/zrangebyscore">Redis Documentation: ZRANGEBYSCORE</a> */ @Nullable Set<TypedTuple<V>> rangeByScoreWithScores(K key, double min, double max); /** * Get elements in range from {@code start} to {@code end} where score is between {@code min} and {@code max} from * sorted set. * * @param key must not be {@literal null}. * @param min * @param max * @param offset * @param count * @return {@literal null} when used in pipeline / transaction. * @see <a href="https://redis.io/commands/zrangebyscore">Redis Documentation: ZRANGEBYSCORE</a> */ @Nullable Set<V> rangeByScore(K key, double min, double max, long offset, long count); /** * Get set of {@link Tuple}s in range from {@code start} to {@code end} where score is between {@code min} and * {@code max} from sorted set. * * @param key * @param min * @param max * @param offset * @param count * @return {@literal null} when used in pipeline / transaction. * @see <a href="https://redis.io/commands/zrangebyscore">Redis Documentation: ZRANGEBYSCORE</a> */ @Nullable Set<TypedTuple<V>> rangeByScoreWithScores(K key, double min, double max, long offset, long count); /** * Get elements in range from {@code start} to {@code end} from sorted set ordered from high to low. * * @param key must not be {@literal null}. * @param start * @param end * @return {@literal null} when used in pipeline / transaction. * @see <a href="https://redis.io/commands/zrevrange">Redis Documentation: ZREVRANGE</a> */ @Nullable Set<V> reverseRange(K key, long start, long end); /** * Get set of {@link Tuple}s in range from {@code start} to {@code end} from sorted set ordered from high to low. * * @param key must not be {@literal null}. * @param start * @param end * @return {@literal null} when used in pipeline / transaction. * @see <a href="https://redis.io/commands/zrevrange">Redis Documentation: ZREVRANGE</a> */ @Nullable Set<TypedTuple<V>> reverseRangeWithScores(K key, long start, long end); /** * Get elements where score is between {@code min} and {@code max} from sorted set ordered from high to low. * * @param key must not be {@literal null}. * @param min * @param max * @return {@literal null} when used in pipeline / transaction. * @see <a href="https://redis.io/commands/zrevrange">Redis Documentation: ZREVRANGE</a> */ @Nullable Set<V> reverseRangeByScore(K key, double min, double max); /** * Get set of {@link Tuple} where score is between {@code min} and {@code max} from sorted set ordered from high to * low. * * @param key must not be {@literal null}. * @param min * @param max * @return {@literal null} when used in pipeline / transaction. * @see <a href="https://redis.io/commands/zrevrangebyscore">Redis Documentation: ZREVRANGEBYSCORE</a> */ @Nullable Set<TypedTuple<V>> reverseRangeByScoreWithScores(K key, double min, double max); /** * Get elements in range from {@code start} to {@code end} where score is between {@code min} and {@code max} from * sorted set ordered high -> low. * * @param key must not be {@literal null}. * @param min * @param max * @param offset * @param count * @return {@literal null} when used in pipeline / transaction. * @see <a href="https://redis.io/commands/zrevrangebyscore">Redis Documentation: ZREVRANGEBYSCORE</a> */ @Nullable Set<V> reverseRangeByScore(K key, double min, double max, long offset, long count); /** * Get set of {@link Tuple} in range from {@code start} to {@code end} where score is between {@code min} and * {@code max} from sorted set ordered high -> low. * * @param key must not be {@literal null}. * @param min * @param max * @param offset * @param count * @return {@literal null} when used in pipeline / transaction. * @see <a href="https://redis.io/commands/zrevrangebyscore">Redis Documentation: ZREVRANGEBYSCORE</a> */ @Nullable Set<TypedTuple<V>> reverseRangeByScoreWithScores(K key, double min, double max, long offset, long count); /** * Count number of elements within sorted set with scores between {@code min} and {@code max}. * * @param key must not be {@literal null}. * @param min * @param max * @return {@literal null} when used in pipeline / transaction. * @see <a href="https://redis.io/commands/zcount">Redis Documentation: ZCOUNT</a> */ @Nullable Long count(K key, double min, double max); /** * Returns the number of elements of the sorted set stored with given {@code key}. * * @see #zCard(Object) * @param key * @return {@literal null} when used in pipeline / transaction. * @see <a href="https://redis.io/commands/zcard">Redis Documentation: ZCARD</a> */ @Nullable Long size(K key); /** * Get the size of sorted set with {@code key}. * * @param key must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @since 1.3 * @see <a href="https://redis.io/commands/zcard">Redis Documentation: ZCARD</a> */ @Nullable Long zCard(K key); /** * Get the score of element with {@code value} from sorted set with key {@code key}. * * @param key must not be {@literal null}. * @param o the value. * @return {@literal null} when used in pipeline / transaction. * @see <a href="https://redis.io/commands/zscore">Redis Documentation: ZSCORE</a> */ @Nullable Double score(K key, Object o); /** * 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 * @return {@literal null} when used in pipeline / transaction. * @see <a href="https://redis.io/commands/zremrangebyrank">Redis Documentation: ZREMRANGEBYRANK</a> */ @Nullable Long removeRange(K key, long start, long end); /** * Remove elements with scores between {@code min} and {@code max} from sorted set with {@code key}. * * @param key must not be {@literal null}. * @param min * @param max * @return {@literal null} when used in pipeline / transaction. * @see <a href="https://redis.io/commands/zremrangebyscore">Redis Documentation: ZREMRANGEBYSCORE</a> */ @Nullable Long removeRangeByScore(K key, double min, double max); /** * Union sorted sets at {@code key} and {@code otherKeys} and store result in destination {@code destKey}. * * @param key must not be {@literal null}. * @param otherKey must not be {@literal null}. * @param destKey must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @see <a href="https://redis.io/commands/zunionstore">Redis Documentation: ZUNIONSTORE</a> */ @Nullable Long unionAndStore(K key, K otherKey, K destKey); /** * Union sorted sets at {@code key} and {@code otherKeys} and store result in destination {@code destKey}. * * @param key must not be {@literal null}. * @param otherKeys must not be {@literal null}. * @param destKey must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @see <a href="https://redis.io/commands/zunionstore">Redis Documentation: ZUNIONSTORE</a> */ @Nullable Long unionAndStore(K key, Collection<K> otherKeys, K destKey); /** * Union sorted sets at {@code key} and {@code otherKeys} and store result in destination {@code destKey}. * * @param key must not be {@literal null}. * @param otherKeys must not be {@literal null}. * @param destKey must not be {@literal null}. * @param aggregate must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @since 2.1 * @see <a href="https://redis.io/commands/zunionstore">Redis Documentation: ZUNIONSTORE</a> */ @Nullable default Long unionAndStore(K key, Collection<K> otherKeys, K destKey, Aggregate aggregate) { return unionAndStore(key, otherKeys, destKey, aggregate, Weights.fromSetCount(1 + otherKeys.size())); } /** * Union sorted sets at {@code key} and {@code otherKeys} and store result in destination {@code destKey}. * * @param key must not be {@literal null}. * @param otherKeys must not be {@literal null}. * @param destKey must not be {@literal null}. * @param aggregate must not be {@literal null}. * @param weights must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @since 2.1 * @see <a href="https://redis.io/commands/zunionstore">Redis Documentation: ZUNIONSTORE</a> */ @Nullable Long unionAndStore(K key, Collection<K> otherKeys, K destKey, Aggregate aggregate, Weights weights); /** * Intersect sorted sets at {@code key} and {@code otherKey} and store result in destination {@code destKey}. * * @param key must not be {@literal null}. * @param otherKey must not be {@literal null}. * @param destKey must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @see <a href="https://redis.io/commands/zinterstore">Redis Documentation: ZINTERSTORE</a> */ @Nullable Long intersectAndStore(K key, K otherKey, K destKey); /** * Intersect sorted sets at {@code key} and {@code otherKeys} and store result in destination {@code destKey}. * * @param key must not be {@literal null}. * @param otherKeys must not be {@literal null}. * @param destKey must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @see <a href="https://redis.io/commands/zinterstore">Redis Documentation: ZINTERSTORE</a> */ @Nullable Long intersectAndStore(K key, Collection<K> otherKeys, K destKey); /** * Intersect sorted sets at {@code key} and {@code otherKeys} and store result in destination {@code destKey}. * * @param key must not be {@literal null}. * @param otherKeys must not be {@literal null}. * @param destKey must not be {@literal null}. * @param aggregate must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @since 2.1 * @see <a href="https://redis.io/commands/zinterstore">Redis Documentation: ZINTERSTORE</a> */ @Nullable default Long intersectAndStore(K key, Collection<K> otherKeys, K destKey, Aggregate aggregate) { return intersectAndStore(key, otherKeys, destKey, aggregate, Weights.fromSetCount(1 + otherKeys.size())); } /** * Intersect sorted sets at {@code key} and {@code otherKeys} and store result in destination {@code destKey}. * * @param key must not be {@literal null}. * @param otherKeys must not be {@literal null}. * @param destKey must not be {@literal null}. * @param aggregate must not be {@literal null}. * @param weights must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @since 2.1 * @see <a href="https://redis.io/commands/zinterstore">Redis Documentation: ZINTERSTORE</a> */ @Nullable Long intersectAndStore(K key, Collection<K> otherKeys, K destKey, Aggregate aggregate, Weights weights); /** * Iterate over elements in zset at {@code key}. <br /> * <strong>Important:</strong> Call {@link Cursor#close()} when done to avoid resource leak. * * @param key * @param options * @return {@literal null} when used in pipeline / transaction. * @see <a href="https://redis.io/commands/zscan">Redis Documentation: ZSCAN</a> * @since 1.4 */ Cursor<TypedTuple<V>> scan(K key, ScanOptions options); /** * Get all elements with lexicographical ordering from {@literal ZSET} at {@code key} with a value between * {@link Range#getMin()} and {@link Range#getMax()}. * * @param key must not be {@literal null}. * @param range must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @since 1.7 * @see <a href="https://redis.io/commands/zrangebylex">Redis Documentation: ZRANGEBYLEX</a> */ @Nullable Set<V> rangeByLex(K key, Range range); /** * Get all elements {@literal n} elements, where {@literal n = } {@link Limit#getCount()}, starting at * {@link Limit#getOffset()} with lexicographical ordering from {@literal ZSET} at {@code key} with a value between * {@link Range#getMin()} and {@link Range#getMax()}. * * @param key must not be {@literal null} * @param range must not be {@literal null}. * @param limit can be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @since 1.7 * @see <a href="https://redis.io/commands/zrangebylex">Redis Documentation: ZRANGEBYLEX</a> */ @Nullable Set<V> rangeByLex(K key, Range range, Limit limit); /** * @return never {@literal null}. */ RedisOperations<K, V> getOperations(); }