Package org.redisson.api

Interface RScoredSortedSet<V>

Type Parameters:

V - object type

All Superinterfaces:

Iterable<V>, RExpirable, RExpirableAsync, RObject, RObjectAsync, RScoredSortedSetAsync<V>, RSortable<Set<V>>, RSortableAsync<Set<V>>

All Known Subinterfaces:

RGeo<V>

All Known Implementing Classes:

RedissonGeo, RedissonLexSortedSet, RedissonScoredSortedSet

public interface RScoredSortedSet<V>
extends RScoredSortedSetAsync<V>, Iterable<V>, RExpirable, RSortable<Set<V>>

Set containing elements sorted by score.

Author:

Nikita Koksharov

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	RScoredSortedSet.Aggregate

Method Summary

Modifier and Type	Method	Description
boolean	add(double score, V object)	Adds element to this set, overrides previous score if it has been already added.
int	addAll(Map<V,Double> objects)	Adds all elements contained in the specified map to this sorted set.
Integer	addAndGetRank(double score, V object)	Adds element to this set, overrides previous score if it has been already added.
Integer	addAndGetRevRank(double score, V object)	Adds element to this set, overrides previous score if it has been already added.
List<Integer>	addAndGetRevRank(Map<? extends V,Double> map)	Adds elements to this set, overrides previous score if it has been already added.
boolean	addIfExists(double score, V object)	Adds element to this set only if it's already exists.
boolean	addIfGreater(double score, V object)	Adds element to this set only if new score greater than current score of existed element.
boolean	addIfLess(double score, V object)	Adds element to this set only if new score less than current score of existed element.
Double	addScore(V element, Number value)	Increases score of specified element by value.
Integer	addScoreAndGetRank(V object, Number value)	Adds score to element and returns its rank
Integer	addScoreAndGetRevRank(V object, Number value)	Adds score to element and returns its reverse rank
void	clear()	Removes all elements of this sorted set.
boolean	contains(Object o)	Returns true if this sorted set contains encoded state of the specified element.
boolean	containsAll(Collection<?> c)	Returns true if this sorted set contains all of the elements in encoded state in the specified collection.
int	count(double startScore, boolean startScoreInclusive, double endScore, boolean endScoreInclusive)	Returns the number of elements with a score between startScore and endScore.
int	diff(String... names)	Diff provided ScoredSortedSets and store result to current ScoredSortedSet
Collection<ScoredEntry<V>>	entryRange(double startScore, boolean startScoreInclusive, double endScore, boolean endScoreInclusive)	Returns all entries (value and its score) between startScore and endScore.
Collection<ScoredEntry<V>>	entryRange(double startScore, boolean startScoreInclusive, double endScore, boolean endScoreInclusive, int offset, int count)	Returns all entries (value and its score) between startScore and endScore.
Collection<ScoredEntry<V>>	entryRange(int startIndex, int endIndex)	Returns entries (value and its score) by rank range.
Collection<ScoredEntry<V>>	entryRangeReversed(double startScore, boolean startScoreInclusive, double endScore, boolean endScoreInclusive)	Returns all entries (value and its score) between startScore and endScore in reversed order.
Collection<ScoredEntry<V>>	entryRangeReversed(double startScore, boolean startScoreInclusive, double endScore, boolean endScoreInclusive, int offset, int count)	Returns all entries (value and its score) between startScore and endScore in reversed order.
Collection<ScoredEntry<V>>	entryRangeReversed(int startIndex, int endIndex)	Returns entries (value and its score) by rank range in reverse order.
V	first()	Returns the head element or null if this sorted set is empty.
Double	firstScore()	Returns score of the tail element or returns null if this sorted set is empty.
List<Double>	getScore(List<V> elements)	Returns scores of elements.
Double	getScore(V o)	Returns score of element or null if it doesn't exist.
int	intersection(String... names)	Intersect provided ScoredSortedSets and store result to current ScoredSortedSet
int	intersection(Map<String,Double> nameWithWeight)	Intersect provided ScoredSortedSets mapped to weight multiplier and store result to current ScoredSortedSet
int	intersection(RScoredSortedSet.Aggregate aggregate, String... names)	Intersect provided ScoredSortedSets with defined aggregation method and store result to current ScoredSortedSet
int	intersection(RScoredSortedSet.Aggregate aggregate, Map<String,Double> nameWithWeight)	Intersect provided ScoredSortedSets mapped to weight multiplier with defined aggregation method and store result to current ScoredSortedSet
boolean	isEmpty()	Returns true if this set is empty
Iterator<V>	iterator(int count)	Returns an iterator over elements in this set.
Iterator<V>	iterator(String pattern)	Returns an iterator over elements in this set.
Iterator<V>	iterator(String pattern, int count)	Returns an iterator over elements in this set.
V	last()	Returns the tail element or null if this sorted set is empty.
Double	lastScore()	Returns score of the head element or returns null if this sorted set is empty.
<KOut,VOut> RCollectionMapReduce<V,KOut,VOut>	mapReduce()	Returns RMapReduce object associated with this object
V	pollFirst()	Removes and returns the head element or null if this sorted set is empty.
Collection<V>	pollFirst(int count)	Removes and returns the head elements of this sorted set.
V	pollFirst(long timeout, TimeUnit unit)	Removes and returns the head element or null if this sorted set is empty.
V	pollFirstFromAny(long timeout, TimeUnit unit, String... queueNames)	Removes and returns first available head element of any sorted set, waiting up to the specified wait time if necessary for an element to become available in any of defined sorted sets including this one.
V	pollLast()	Removes and returns the tail element or null if this sorted set is empty.
Collection<V>	pollLast(int count)	Removes and returns the tail elements of this sorted set.
V	pollLast(long timeout, TimeUnit unit)	Removes and returns the tail element or null if this sorted set is empty.
V	pollLastFromAny(long timeout, TimeUnit unit, String... queueNames)	Removes and returns first available tail element of any sorted set, waiting up to the specified wait time if necessary for an element to become available in any of defined sorted sets including this one.
V	random()	Returns random element from this sorted set
Collection<V>	random(int count)	Returns random elements from this sorted set limited by count
Map<V,Double>	randomEntries(int count)	Returns random entries from this sorted set limited by count.
int	rangeTo(String destName, double startScore, boolean startScoreInclusive, double endScore, boolean endScoreInclusive)	Stores to defined ScoredSortedSet values between startScore and endScore.
int	rangeTo(String destName, double startScore, boolean startScoreInclusive, double endScore, boolean endScoreInclusive, int offset, int count)	Stores to defined ScoredSortedSet values between startScore and endScore.
int	rangeTo(String destName, int startIndex, int endIndex)	Stores to defined ScoredSortedSet values by rank range.
Integer	rank(V o)	Returns rank of value, with the scores ordered from low to high.
Collection<V>	readAll()	Read all values at once.
Collection<V>	readDiff(String... names)	Diff ScoredSortedSets specified by name with current ScoredSortedSet without state change.
Collection<V>	readIntersection(String... names)	Intersect provided ScoredSortedSets with current ScoredSortedSet without state change
Collection<V>	readIntersection(Map<String,Double> nameWithWeight)	Intersect provided ScoredSortedSets mapped to weight multiplier with current ScoredSortedSet without state change
Collection<V>	readIntersection(RScoredSortedSet.Aggregate aggregate, String... names)	Intersect provided ScoredSortedSets with current ScoredSortedSet using defined aggregation method without state change
Collection<V>	readIntersection(RScoredSortedSet.Aggregate aggregate, Map<String,Double> nameWithWeight)	Intersect provided ScoredSortedSets mapped to weight multiplier with current ScoredSortedSet using defined aggregation method without state change
Collection<V>	readUnion(String... names)	Union ScoredSortedSets specified by name with current ScoredSortedSet without state change.
Collection<V>	readUnion(Map<String,Double> nameWithWeight)	Union provided ScoredSortedSets mapped to weight multiplier and current ScoredSortedSet without state change.
Collection<V>	readUnion(RScoredSortedSet.Aggregate aggregate, String... names)	Union ScoredSortedSets specified by name with defined aggregation method and current ScoredSortedSet without state change.
Collection<V>	readUnion(RScoredSortedSet.Aggregate aggregate, Map<String,Double> nameWithWeight)	Union provided ScoredSortedSets mapped to weight multiplier with defined aggregation method and current ScoredSortedSet without state change
boolean	remove(Object o)	Removes a single instance of the specified element from this sorted set, if it is present.
boolean	removeAll(Collection<?> c)	Removes all of this sorted set's elements that are also contained in the specified collection.
int	removeRangeByRank(int startIndex, int endIndex)	Removes values by rank range.
int	removeRangeByScore(double startScore, boolean startScoreInclusive, double endScore, boolean endScoreInclusive)	Removes values by score range.
boolean	retainAll(Collection<?> c)	Retains only the elements in this sorted set that are contained in the specified collection.
int	revRangeTo(String destName, double startScore, boolean startScoreInclusive, double endScore, boolean endScoreInclusive)	Stores to defined ScoredSortedSet values in reversed order between startScore and endScore.
int	revRangeTo(String destName, double startScore, boolean startScoreInclusive, double endScore, boolean endScoreInclusive, int offset, int count)	Stores to defined ScoredSortedSet values in reversed order between startScore and endScore.
int	revRangeTo(String destName, int startIndex, int endIndex)	Stores to defined ScoredSortedSet values in reversed order by rank range.
List<Integer>	revRank(Collection<V> elements)	Returns ranks of elements, with the scores ordered from high to low.
Integer	revRank(V o)	Returns rank of value, with the scores ordered from high to low.
int	size()	Returns size of this set.
Stream<V>	stream()	Returns stream of elements in this set.
Stream<V>	stream(int count)	Returns stream of elements in this set.
Stream<V>	stream(String pattern)	Returns stream of elements in this set.
Stream<V>	stream(String pattern, int count)	Returns stream of elements in this set.
int	subscribeOnFirstElements(Consumer<V> consumer)	Subscribes on first elements appeared in this set.
int	subscribeOnLastElements(Consumer<V> consumer)	Subscribes on last elements appeared in this set.
V	takeFirst()	Removes and returns the head element waiting if necessary for an element to become available.
V	takeLast()	Removes and returns the tail element waiting if necessary for an element to become available.
Object[]	toArray()	Returns this sorted set in array of Object type.
<T> T[]	toArray(T[] a)	Returns this sorted set in array of defined type.
boolean	tryAdd(double score, V object)	Adds element to this set only if has not been added before.
int	union(String... names)	Union provided ScoredSortedSets and store result to current ScoredSortedSet
int	union(Map<String,Double> nameWithWeight)	Union provided ScoredSortedSets mapped to weight multiplier and store result to current ScoredSortedSet
int	union(RScoredSortedSet.Aggregate aggregate, String... names)	Union provided ScoredSortedSets with defined aggregation method and store result to current ScoredSortedSet
int	union(RScoredSortedSet.Aggregate aggregate, Map<String,Double> nameWithWeight)	Union provided ScoredSortedSets mapped to weight multiplier with defined aggregation method and store result to current ScoredSortedSet
void	unsubscribe(int listenerId)	Un-subscribes defined listener.
Collection<V>	valueRange(double startScore, boolean startScoreInclusive, double endScore, boolean endScoreInclusive)	Returns all values between startScore and endScore.
Collection<V>	valueRange(double startScore, boolean startScoreInclusive, double endScore, boolean endScoreInclusive, int offset, int count)	Returns all values between startScore and endScore.
Collection<V>	valueRange(int startIndex, int endIndex)	Returns values by rank range.
Collection<V>	valueRangeReversed(double startScore, boolean startScoreInclusive, double endScore, boolean endScoreInclusive)	Returns all values between startScore and endScore in reversed order.
Collection<V>	valueRangeReversed(double startScore, boolean startScoreInclusive, double endScore, boolean endScoreInclusive, int offset, int count)	Returns all values between startScore and endScore in reversed order.
Collection<V>	valueRangeReversed(int startIndex, int endIndex)	Returns values by rank range in reverse order.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface org.redisson.api.RExpirable

clearExpire, expire, expire, expireAt, expireAt, remainTimeToLive

Methods inherited from interface org.redisson.api.RExpirableAsync

clearExpireAsync, expireAsync, expireAsync, expireAtAsync, expireAtAsync, remainTimeToLiveAsync

Methods inherited from interface org.redisson.api.RObject

addListener, copy, delete, dump, getCodec, getIdleTime, getName, isExists, migrate, move, removeListener, rename, renamenx, restore, restore, restoreAndReplace, restoreAndReplace, sizeInMemory, touch, unlink

Methods inherited from interface org.redisson.api.RObjectAsync

addListenerAsync, copyAsync, deleteAsync, dumpAsync, getIdleTimeAsync, isExistsAsync, migrateAsync, moveAsync, removeListenerAsync, renameAsync, renamenxAsync, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, sizeInMemoryAsync, touchAsync, unlinkAsync

Methods inherited from interface org.redisson.api.RScoredSortedSetAsync

addAllAsync, addAndGetRankAsync, addAndGetRevRankAsync, addAndGetRevRankAsync, addAsync, addIfExistsAsync, addIfGreaterAsync, addIfLessAsync, addScoreAndGetRankAsync, addScoreAndGetRevRankAsync, addScoreAsync, containsAllAsync, containsAsync, countAsync, diffAsync, entryRangeAsync, entryRangeAsync, entryRangeAsync, entryRangeReversedAsync, entryRangeReversedAsync, entryRangeReversedAsync, firstAsync, firstScoreAsync, getScoreAsync, getScoreAsync, intersectionAsync, intersectionAsync, intersectionAsync, intersectionAsync, lastAsync, lastScoreAsync, pollFirstAsync, pollFirstAsync, pollFirstAsync, pollFirstFromAnyAsync, pollLastAsync, pollLastAsync, pollLastAsync, pollLastFromAnyAsync, randomAsync, randomAsync, randomEntriesAsync, rangeToAsync, rangeToAsync, rangeToAsync, rankAsync, readAllAsync, readDiffAsync, readIntersectionAsync, readIntersectionAsync, readIntersectionAsync, readIntersectionAsync, readUnionAsync, readUnionAsync, readUnionAsync, readUnionAsync, removeAllAsync, removeAsync, removeRangeByRankAsync, removeRangeByScoreAsync, retainAllAsync, revRangeToAsync, revRangeToAsync, revRangeToAsync, revRankAsync, revRankAsync, sizeAsync, takeFirstAsync, takeLastAsync, tryAddAsync, unionAsync, unionAsync, unionAsync, unionAsync, valueRangeAsync, valueRangeAsync, valueRangeAsync, valueRangeReversedAsync, valueRangeReversedAsync, valueRangeReversedAsync

Methods inherited from interface org.redisson.api.RSortable

readSort, readSort, readSort, readSort, readSort, readSort, readSortAlpha, readSortAlpha, readSortAlpha, readSortAlpha, readSortAlpha, readSortAlpha, sortTo, sortTo, sortTo, sortTo, sortTo, sortTo

Methods inherited from interface org.redisson.api.RSortableAsync

readSortAlphaAsync, readSortAlphaAsync, readSortAlphaAsync, readSortAlphaAsync, readSortAlphaAsync, readSortAlphaAsync, readSortAsync, readSortAsync, readSortAsync, readSortAsync, readSortAsync, readSortAsync, sortToAsync, sortToAsync, sortToAsync, sortToAsync, sortToAsync, sortToAsync

Method Detail

mapReduce

<KOut,VOut> RCollectionMapReduce<V,KOut,VOut> mapReduce()

Returns RMapReduce object associated with this object

Type Parameters:

KOut - output key

VOut - output value

Returns:

MapReduce instance

pollLastFromAny

V pollLastFromAny(long timeout,
                  TimeUnit unit,
                  String... queueNames)

Removes and returns first available tail element of any sorted set, waiting up to the specified wait time if necessary for an element to become available in any of defined sorted sets including this one.

Requires Redis 5.0.0 and higher.

Parameters:

queueNames - - names of queue

timeout - how long to wait before giving up, in units of unit

unit - a TimeUnit determining how to interpret the timeout parameter

Returns:

the tail element, or null if all sorted sets are empty

pollFirstFromAny

V pollFirstFromAny(long timeout,
                   TimeUnit unit,
                   String... queueNames)

Removes and returns first available head element of any sorted set, waiting up to the specified wait time if necessary for an element to become available in any of defined sorted sets including this one.

Requires Redis 5.0.0 and higher.

Parameters:

queueNames - - names of queue

timeout - how long to wait before giving up, in units of unit

unit - a TimeUnit determining how to interpret the timeout parameter

Returns:

the head element, or null if all sorted sets are empty

takeFirst

V takeFirst()

Removes and returns the head element waiting if necessary for an element to become available.

Returns:

the head element

takeLast

V takeLast()

Removes and returns the tail element waiting if necessary for an element to become available.

Returns:

the tail element

subscribeOnFirstElements

int subscribeOnFirstElements(Consumer<V> consumer)

Subscribes on first elements appeared in this set. Continuously invokes RScoredSortedSetAsync.takeFirstAsync() method to get a new element.

Parameters:

consumer - - queue elements listener

Returns:

listenerId - id of listener

subscribeOnLastElements

int subscribeOnLastElements(Consumer<V> consumer)

Subscribes on last elements appeared in this set. Continuously invokes RScoredSortedSetAsync.takeLastAsync() method to get a new element.

Parameters:

consumer - - queue elements listener

Returns:

listenerId - id of listener

unsubscribe

void unsubscribe(int listenerId)

Un-subscribes defined listener.

Parameters:

listenerId - - id of listener

pollFirst

V pollFirst(long timeout,
            TimeUnit unit)

Removes and returns the head element or null if this sorted set is empty.

Parameters:

timeout - how long to wait before giving up, in units of unit

unit - a TimeUnit determining how to interpret the timeout parameter

Returns:

the head element, or null if this sorted set is empty

pollLast

V pollLast(long timeout,
           TimeUnit unit)

Removes and returns the tail element or null if this sorted set is empty.

Parameters:

timeout - how long to wait before giving up, in units of unit

unit - a TimeUnit determining how to interpret the timeout parameter

Returns:

the tail element or null if this sorted set is empty

pollFirst

Collection<V> pollFirst(int count)

Removes and returns the head elements of this sorted set.

Parameters:

count - - elements amount

Returns:

the head elements of this sorted set

pollLast

Collection<V> pollLast(int count)

Removes and returns the tail elements of this sorted set.

Parameters:

count - - elements amount

Returns:

the tail elements of this sorted set

pollFirst

V pollFirst()

Removes and returns the head element or null if this sorted set is empty.

Returns:

the head element, or null if this sorted set is empty

pollLast

V pollLast()

Removes and returns the tail element or null if this sorted set is empty.

Returns:

the tail element or null if this sorted set is empty

first

V first()

Returns the head element or null if this sorted set is empty.

Returns:

the head element or null if this sorted set is empty

last

V last()

Returns the tail element or null if this sorted set is empty.

Returns:

the tail element or null if this sorted set is empty

firstScore

Double firstScore()

Returns score of the tail element or returns null if this sorted set is empty.

Returns:

the tail element or null if this sorted set is empty

lastScore

Double lastScore()

Returns score of the head element or returns null if this sorted set is empty.

Returns:

the tail element or null if this sorted set is empty

random

V random()

Returns random element from this sorted set

Requires Redis 6.2.0 and higher.

Returns:

random element

random

Collection<V> random(int count)

Returns random elements from this sorted set limited by count

Requires Redis 6.2.0 and higher.

Parameters:

count - - values amount to return

Returns:

random elements

randomEntries

Map<V,Double> randomEntries(int count)

Returns random entries from this sorted set limited by count. Each map entry uses element as key and score as value.

Requires Redis 6.2.0 and higher.

Parameters:

count - - entries amount to return

Returns:

random entries

addAll

int addAll(Map<V,Double> objects)

Adds all elements contained in the specified map to this sorted set. Map contains of score mapped by object.

Parameters:

objects - - map of elements to add

Returns:

amount of added elements, not including already existing in this sorted set

removeRangeByScore

int removeRangeByScore(double startScore,
                       boolean startScoreInclusive,
                       double endScore,
                       boolean endScoreInclusive)

Removes values by score range.

Parameters:

startScore - - start score. Use Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY to define infinity numbers

startScoreInclusive - - start score inclusive

endScore - - end score Use Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY to define infinity numbers

endScoreInclusive - - end score inclusive

Returns:

number of elements removed

removeRangeByRank

int removeRangeByRank(int startIndex,
                      int endIndex)

Removes values by rank range. Indexes are zero based. -1 means the highest score, -2 means the second highest score.

Parameters:

startIndex - - start index

endIndex - - end index

Returns:

number of elements removed

rank

Integer rank(V o)

Returns rank of value, with the scores ordered from low to high.

Parameters:

o - - object

Returns:

rank or null if value does not exist

revRank

Integer revRank(V o)

Returns rank of value, with the scores ordered from high to low.

Parameters:

o - - object

Returns:

rank or null if value does not exist

revRank

List<Integer> revRank(Collection<V> elements)

Returns ranks of elements, with the scores ordered from high to low.

Parameters:

elements - - elements

Returns:

ranks or null if value does not exist

getScore

Double getScore(V o)

Returns score of element or null if it doesn't exist.

Parameters:

o - - element

Returns:

score

getScore

List<Double> getScore(List<V> elements)

Returns scores of elements.

Parameters:

elements - - elements

Returns:

element scores

add

boolean add(double score,
            V object)

Adds element to this set, overrides previous score if it has been already added.

Parameters:

score - - object score

object - - object itself

Returns:

true if element has added and false if not.

addAndGetRank

Integer addAndGetRank(double score,
                      V object)

Adds element to this set, overrides previous score if it has been already added. Finally return the rank of the item

Parameters:

score - - object score

object - - object itself

Returns:

rank

addAndGetRevRank

Integer addAndGetRevRank(double score,
                         V object)

Adds element to this set, overrides previous score if it has been already added. Finally return the reverse rank of the item

Parameters:

score - - object score

object - - object itself

Returns:

reverse rank

addAndGetRevRank

List<Integer> addAndGetRevRank(Map<? extends V,Double> map)

Adds elements to this set, overrides previous score if it has been already added. Finally returns reverse rank list of the items

Parameters:

map - - map of object and scores, make sure to use an ordered map

Returns:

collection of reverse ranks

tryAdd

boolean tryAdd(double score,
               V object)

Adds element to this set only if has not been added before.

Requires Redis 3.0.2 and higher.

Parameters:

score - - object score

object - - object itself

Returns:

true if element added and false if not.

addIfExists

boolean addIfExists(double score,
                    V object)

Adds element to this set only if it's already exists.

Requires Redis 3.0.2 and higher.

Parameters:

score - - object score

object - - object itself

Returns:

true if element added and false if not.

addIfLess

boolean addIfLess(double score,
                  V object)

Adds element to this set only if new score less than current score of existed element.

Requires Redis 6.2.0 and higher.

Parameters:

score - - object score

object - - object itself

Returns:

true if element added and false if not.

addIfGreater

boolean addIfGreater(double score,
                     V object)

Adds element to this set only if new score greater than current score of existed element.

Requires Redis 6.2.0 and higher.

Parameters:

score - - object score

object - - object itself

Returns:

true if element added and false if not.

size

int size()

Returns size of this set.

Returns:

size

isEmpty

boolean isEmpty()

Returns true if this set is empty

Returns:

true if empty

stream

Stream<V> stream()

Returns stream of elements in this set. Elements are loaded in batch. Batch size is 10.

Returns:

stream of elements

stream

Stream<V> stream(String pattern)

Returns stream of elements in this set. If pattern is not null then only elements match this pattern are loaded.

Parameters:

pattern - - search pattern

Returns:

stream of elements

stream

Stream<V> stream(int count)

Returns stream of elements in this set. Elements are loaded in batch. Batch size is defined by count param.

Parameters:

count - - size of elements batch

Returns:

stream of elements

stream

Stream<V> stream(String pattern,
                 int count)

Returns stream of elements in this set. Elements are loaded in batch. Batch size is defined by count param. If pattern is not null then only elements match this pattern are loaded.

Parameters:

pattern - - search pattern

count - - size of elements batch

Returns:

stream of elements

iterator

Iterator<V> iterator(String pattern)

Returns an iterator over elements in this set. If pattern is not null then only elements match this pattern are loaded.

Parameters:

pattern - - search pattern

Returns:

iterator

iterator

Iterator<V> iterator(int count)

Returns an iterator over elements in this set. Elements are loaded in batch. Batch size is defined by count param.

Parameters:

count - - size of elements batch

Returns:

iterator

iterator

Iterator<V> iterator(String pattern,
                     int count)

Returns an iterator over elements in this set. Elements are loaded in batch. Batch size is defined by count param. If pattern is not null then only elements match this pattern are loaded.

Parameters:

pattern - - search pattern

count - - size of elements batch

Returns:

iterator

contains

boolean contains(Object o)

Returns true if this sorted set contains encoded state of the specified element.

Parameters:

o - element whose presence in this collection is to be tested

Returns:

true if this sorted set contains the specified element and false otherwise

toArray

Object[] toArray()

Returns this sorted set in array of Object type.

Returns:

array of values

toArray

<T> T[] toArray(T[] a)

Returns this sorted set in array of defined type.

Type Parameters:

T - type of element

Parameters:

a - - instance of array

Returns:

array of values

remove

boolean remove(Object o)

Removes a single instance of the specified element from this sorted set, if it is present.

Parameters:

o - element to be removed from this sorted set, if present

Returns:

true if an element was removed as a result of this call

containsAll

boolean containsAll(Collection<?> c)

Returns true if this sorted set contains all of the elements in encoded state in the specified collection.

Parameters:

c - collection to be checked for containment in this sorted set

Returns:

true if this sorted set contains all of the elements in the specified collection

removeAll

boolean removeAll(Collection<?> c)

Removes all of this sorted set's elements that are also contained in the specified collection.

Parameters:

c - collection containing elements to be removed from this collection

Returns:

true if this sorted set changed as a result of the call

retainAll

boolean retainAll(Collection<?> c)

Retains only the elements in this sorted set that are contained in the specified collection.

Parameters:

c - collection containing elements to be retained in this collection

Returns:

true if this sorted set changed as a result of the call

clear

void clear()

Removes all elements of this sorted set.

addScore

Double addScore(V element,
                Number value)

Increases score of specified element by value.

Parameters:

element - - element whose score needs to be increased

value - - value

Returns:

updated score of element

addScoreAndGetRank

Integer addScoreAndGetRank(V object,
                           Number value)

Adds score to element and returns its rank

Parameters:

object - - object itself

value - - object score

Returns:

rank

addScoreAndGetRevRank

Integer addScoreAndGetRevRank(V object,
                              Number value)

Adds score to element and returns its reverse rank

Parameters:

object - - object itself

value - - object score

Returns:

reverse rank

rangeTo

int rangeTo(String destName,
            int startIndex,
            int endIndex)

Stores to defined ScoredSortedSet values by rank range. Indexes are zero based. -1 means the highest score, -2 means the second highest score.

Requires Redis 6.2.0 and higher.

Parameters:

startIndex - - start index

endIndex - - end index

Returns:

elements

rangeTo

int rangeTo(String destName,
            double startScore,
            boolean startScoreInclusive,
            double endScore,
            boolean endScoreInclusive)

Stores to defined ScoredSortedSet values between startScore and endScore.

Requires Redis 6.2.0 and higher.

Parameters:

startScore - - start score. Use Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY to define infinity numbers

startScoreInclusive - - start score inclusive

endScore - - end score Use Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY to define infinity numbers

endScoreInclusive - - end score inclusive

Returns:

values

rangeTo

int rangeTo(String destName,
            double startScore,
            boolean startScoreInclusive,
            double endScore,
            boolean endScoreInclusive,
            int offset,
            int count)

Stores to defined ScoredSortedSet values between startScore and endScore.

Requires Redis 6.2.0 and higher.

Parameters:

startScore - - start score. Use Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY to define infinity numbers

startScoreInclusive - - start score inclusive

endScore - - end score Use Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY to define infinity numbers

endScoreInclusive - - end score inclusive

offset - - offset of sorted data

count - - amount of sorted data

Returns:

values

revRangeTo

int revRangeTo(String destName,
               int startIndex,
               int endIndex)

Stores to defined ScoredSortedSet values in reversed order by rank range. Indexes are zero based. -1 means the highest score, -2 means the second highest score.

Requires Redis 6.2.0 and higher.

Parameters:

startIndex - - start index

endIndex - - end index

Returns:

elements

revRangeTo

int revRangeTo(String destName,
               double startScore,
               boolean startScoreInclusive,
               double endScore,
               boolean endScoreInclusive)

Stores to defined ScoredSortedSet values in reversed order between startScore and endScore.

Requires Redis 6.2.0 and higher.

Parameters:

startScore - - start score. Use Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY to define infinity numbers

startScoreInclusive - - start score inclusive

endScore - - end score Use Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY to define infinity numbers

endScoreInclusive - - end score inclusive

Returns:

values

revRangeTo

int revRangeTo(String destName,
               double startScore,
               boolean startScoreInclusive,
               double endScore,
               boolean endScoreInclusive,
               int offset,
               int count)

Stores to defined ScoredSortedSet values in reversed order between startScore and endScore.

Requires Redis 6.2.0 and higher.

Parameters:

startScore - - start score. Use Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY to define infinity numbers

startScoreInclusive - - start score inclusive

endScore - - end score Use Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY to define infinity numbers

endScoreInclusive - - end score inclusive

offset - - offset of sorted data

count - - amount of sorted data

Returns:

values

valueRange

Collection<V> valueRange(int startIndex,
                         int endIndex)

Returns values by rank range. Indexes are zero based. -1 means the highest score, -2 means the second highest score.

Parameters:

startIndex - - start index

endIndex - - end index

Returns:

elements

valueRangeReversed

Collection<V> valueRangeReversed(int startIndex,
                                 int endIndex)

Returns values by rank range in reverse order. Indexes are zero based. -1 means the highest score, -2 means the second highest score.

Parameters:

startIndex - - start index

endIndex - - end index

Returns:

elements

entryRange

Collection<ScoredEntry<V>> entryRange(int startIndex,
                                      int endIndex)

Returns entries (value and its score) by rank range. Indexes are zero based. -1 means the highest score, -2 means the second highest score.

Parameters:

startIndex - - start index

endIndex - - end index

Returns:

entries

entryRangeReversed

Collection<ScoredEntry<V>> entryRangeReversed(int startIndex,
                                              int endIndex)

Returns entries (value and its score) by rank range in reverse order. Indexes are zero based. -1 means the highest score, -2 means the second highest score.

Parameters:

startIndex - - start index

endIndex - - end index

Returns:

entries

valueRange

Collection<V> valueRange(double startScore,
                         boolean startScoreInclusive,
                         double endScore,
                         boolean endScoreInclusive)

Returns all values between startScore and endScore.

Parameters:

startScore - - start score. Use Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY to define infinity numbers

startScoreInclusive - - start score inclusive

endScore - - end score Use Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY to define infinity numbers

endScoreInclusive - - end score inclusive

Returns:

values

valueRangeReversed

Collection<V> valueRangeReversed(double startScore,
                                 boolean startScoreInclusive,
                                 double endScore,
                                 boolean endScoreInclusive)

Returns all values between startScore and endScore in reversed order.

Parameters:

startScore - - start score. Use Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY to define infinity numbers

startScoreInclusive - - start score inclusive

endScore - - end score Use Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY to define infinity numbers

endScoreInclusive - - end score inclusive

Returns:

values

entryRange

Collection<ScoredEntry<V>> entryRange(double startScore,
                                      boolean startScoreInclusive,
                                      double endScore,
                                      boolean endScoreInclusive)

Returns all entries (value and its score) between startScore and endScore.

Parameters:

startScore - - start score. Use Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY to define infinity numbers

startScoreInclusive - - start score inclusive

endScore - - end score Use Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY to define infinity numbers

endScoreInclusive - - end score inclusive

Returns:

entries

valueRange

Collection<V> valueRange(double startScore,
                         boolean startScoreInclusive,
                         double endScore,
                         boolean endScoreInclusive,
                         int offset,
                         int count)

Returns all values between startScore and endScore.

Parameters:

startScore - - start score. Use Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY to define infinity numbers

startScoreInclusive - - start score inclusive

endScore - - end score Use Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY to define infinity numbers

endScoreInclusive - - end score inclusive

offset - - offset of sorted data

count - - amount of sorted data

Returns:

values

valueRangeReversed

Collection<V> valueRangeReversed(double startScore,
                                 boolean startScoreInclusive,
                                 double endScore,
                                 boolean endScoreInclusive,
                                 int offset,
                                 int count)

Returns all values between startScore and endScore in reversed order.

Parameters:

startScore - - start score. Use Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY to define infinity numbers

startScoreInclusive - - start score inclusive

endScore - - end score Use Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY to define infinity numbers

endScoreInclusive - - end score inclusive

offset - - offset of sorted data

count - - amount of sorted data

Returns:

values

entryRange

Collection<ScoredEntry<V>> entryRange(double startScore,
                                      boolean startScoreInclusive,
                                      double endScore,
                                      boolean endScoreInclusive,
                                      int offset,
                                      int count)

Returns all entries (value and its score) between startScore and endScore.

Parameters:

startScore - - start score. Use Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY to define infinity numbers

startScoreInclusive - - start score inclusive

endScore - - end score Use Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY to define infinity numbers

endScoreInclusive - - end score inclusive

offset - - offset of sorted data

count - - amount of sorted data

Returns:

entries

entryRangeReversed

Collection<ScoredEntry<V>> entryRangeReversed(double startScore,
                                              boolean startScoreInclusive,
                                              double endScore,
                                              boolean endScoreInclusive)

Returns all entries (value and its score) between startScore and endScore in reversed order.

Parameters:

startScore - - start score. Use Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY to define infinity numbers

startScoreInclusive - - start score inclusive

endScore - - end score Use Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY to define infinity numbers

endScoreInclusive - - end score inclusive

Returns:

entries

entryRangeReversed

Collection<ScoredEntry<V>> entryRangeReversed(double startScore,
                                              boolean startScoreInclusive,
                                              double endScore,
                                              boolean endScoreInclusive,
                                              int offset,
                                              int count)

Returns all entries (value and its score) between startScore and endScore in reversed order.

Parameters:

startScore - - start score. Use Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY to define infinity numbers

startScoreInclusive - - start score inclusive

endScore - - end score Use Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY to define infinity numbers

endScoreInclusive - - end score inclusive

offset - - offset of sorted data

count - - amount of sorted data

Returns:

entries

count

int count(double startScore,
          boolean startScoreInclusive,
          double endScore,
          boolean endScoreInclusive)

Returns the number of elements with a score between startScore and endScore.

Parameters:

startScore - - start score

startScoreInclusive - - start score inclusive

endScore - - end score

endScoreInclusive - - end score inclusive

Returns:

count of elements

readAll

Collection<V> readAll()

Read all values at once.

Returns:

values

intersection

int intersection(String... names)

Intersect provided ScoredSortedSets and store result to current ScoredSortedSet

Parameters:

names - - names of ScoredSortedSet

Returns:

length of intersection

intersection

int intersection(RScoredSortedSet.Aggregate aggregate,
                 String... names)

Intersect provided ScoredSortedSets with defined aggregation method and store result to current ScoredSortedSet

Parameters:

aggregate - - score aggregation mode

names - - names of ScoredSortedSet

Returns:

length of intersection

intersection

int intersection(Map<String,Double> nameWithWeight)

Intersect provided ScoredSortedSets mapped to weight multiplier and store result to current ScoredSortedSet

Parameters:

nameWithWeight - - name of ScoredSortedSet mapped to weight multiplier

Returns:

length of intersection

intersection

int intersection(RScoredSortedSet.Aggregate aggregate,
                 Map<String,Double> nameWithWeight)

Intersect provided ScoredSortedSets mapped to weight multiplier with defined aggregation method and store result to current ScoredSortedSet

Parameters:

aggregate - - score aggregation mode

nameWithWeight - - name of ScoredSortedSet mapped to weight multiplier

Returns:

length of intersection

readIntersection

Collection<V> readIntersection(String... names)

Intersect provided ScoredSortedSets with current ScoredSortedSet without state change

Requires Redis 6.2.0 and higher.

Parameters:

names - - names of ScoredSortedSet

Returns:

result of intersection

readIntersection

Collection<V> readIntersection(RScoredSortedSet.Aggregate aggregate,
                               String... names)

Intersect provided ScoredSortedSets with current ScoredSortedSet using defined aggregation method without state change

Requires Redis 6.2.0 and higher.

Parameters:

aggregate - - score aggregation mode

names - - names of ScoredSortedSet

Returns:

result of intersection

readIntersection

Collection<V> readIntersection(Map<String,Double> nameWithWeight)

Intersect provided ScoredSortedSets mapped to weight multiplier with current ScoredSortedSet without state change

Requires Redis 6.2.0 and higher.

Parameters:

nameWithWeight - - name of ScoredSortedSet mapped to weight multiplier

Returns:

result of intersection

readIntersection

Collection<V> readIntersection(RScoredSortedSet.Aggregate aggregate,
                               Map<String,Double> nameWithWeight)

Intersect provided ScoredSortedSets mapped to weight multiplier with current ScoredSortedSet using defined aggregation method without state change

Requires Redis 6.2.0 and higher.

Parameters:

aggregate - - score aggregation mode

nameWithWeight - - name of ScoredSortedSet mapped to weight multiplier

Returns:

result of intersection

union

int union(String... names)

Union provided ScoredSortedSets and store result to current ScoredSortedSet

Parameters:

names - - names of ScoredSortedSet

Returns:

length of union

union

int union(RScoredSortedSet.Aggregate aggregate,
          String... names)

Union provided ScoredSortedSets with defined aggregation method and store result to current ScoredSortedSet

Parameters:

aggregate - - score aggregation mode

names - - names of ScoredSortedSet

Returns:

length of union

union

int union(Map<String,Double> nameWithWeight)

Union provided ScoredSortedSets mapped to weight multiplier and store result to current ScoredSortedSet

Parameters:

nameWithWeight - - name of ScoredSortedSet mapped to weight multiplier

Returns:

length of union

union

int union(RScoredSortedSet.Aggregate aggregate,
          Map<String,Double> nameWithWeight)

Union provided ScoredSortedSets mapped to weight multiplier with defined aggregation method and store result to current ScoredSortedSet

Parameters:

aggregate - - score aggregation mode

nameWithWeight - - name of ScoredSortedSet mapped to weight multiplier

Returns:

length of union

readUnion

Collection<V> readUnion(String... names)

Union ScoredSortedSets specified by name with current ScoredSortedSet without state change.

Requires Redis 6.2.0 and higher.

Parameters:

names - - names of ScoredSortedSet

Returns:

result of union

readUnion

Collection<V> readUnion(RScoredSortedSet.Aggregate aggregate,
                        String... names)

Union ScoredSortedSets specified by name with defined aggregation method and current ScoredSortedSet without state change.

Requires Redis 6.2.0 and higher.

Parameters:

aggregate - - score aggregation mode

names - - names of ScoredSortedSet

Returns:

result of union

readUnion

Collection<V> readUnion(Map<String,Double> nameWithWeight)

Union provided ScoredSortedSets mapped to weight multiplier and current ScoredSortedSet without state change.

Requires Redis 6.2.0 and higher.

Parameters:

nameWithWeight - - name of ScoredSortedSet mapped to weight multiplier

Returns:

result of union

readUnion

Collection<V> readUnion(RScoredSortedSet.Aggregate aggregate,
                        Map<String,Double> nameWithWeight)

Union provided ScoredSortedSets mapped to weight multiplier with defined aggregation method and current ScoredSortedSet without state change

Requires Redis 6.2.0 and higher.

Parameters:

aggregate - - score aggregation mode

nameWithWeight - - name of ScoredSortedSet mapped to weight multiplier

Returns:

result of union

readDiff

Collection<V> readDiff(String... names)

Diff ScoredSortedSets specified by name with current ScoredSortedSet without state change.

Requires Redis 6.2.0 and higher.

Parameters:

names - - name of sets

Returns:

result of diff

diff

int diff(String... names)

Diff provided ScoredSortedSets and store result to current ScoredSortedSet

Requires Redis 6.2.0 and higher.

Parameters:

names - - name of sets

Returns:

length of diff