Package org.redisson.api

Interface RSortedSet<V>

Type Parameters:

V - value type

All Superinterfaces:

Collection<V>, Iterable<V>, RExpirable, RExpirableAsync, RObject, RObjectAsync, Set<V>, SortedSet<V>

All Known Subinterfaces:

RLexSortedSet

All Known Implementing Classes:

RedissonLexSortedSet, RedissonSortedSet

public interface RSortedSet<V>
extends SortedSet<V>, RExpirable

Author:

Nikita Koksharov

Method Summary

Modifier and Type	Method	Description
RFuture<Boolean>	addAsync(V value)
Iterator<V>	distributedIterator(int count)	Returns element iterator that can be shared across multiple applications.
Iterator<V>	distributedIterator(String iteratorName, int count)	Returns iterator over elements that match specified pattern.
<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(Duration duration)	Removes and returns the head element or null if this sorted set is empty.
List<V>	pollFirst(Duration duration, int count)	Removes and returns the head elements.
RFuture<V>	pollFirstAsync()	Removes and returns the head element or null if this sorted set is empty.
RFuture<Collection<V>>	pollFirstAsync(int count)	Removes and returns the head elements of this sorted set.
RFuture<V>	pollFirstAsync(Duration duration)	Removes and returns the head element or null if this sorted set is empty.
RFuture<List<V>>	pollFirstAsync(Duration duration, int count)	Removes and returns the head elements.
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(Duration duration)	Removes and returns the tail element or null if this sorted set is empty.
List<V>	pollLast(Duration duration, int count)	Removes and returns the tail elements.
RFuture<V>	pollLastAsync()	Removes and returns the tail element or null if this sorted set is empty.
RFuture<Collection<V>>	pollLastAsync(int count)	Removes and returns the tail elements of this sorted set.
RFuture<V>	pollLastAsync(Duration duration)	Removes and returns the tail element or null if this sorted set is empty.
RFuture<List<V>>	pollLastAsync(Duration duration, int count)	Removes and returns the tail elements.
Collection<V>	readAll()
RFuture<Collection<V>>	readAllAsync()
RFuture<Boolean>	removeAsync(Object value)
boolean	trySetComparator(Comparator<? super V> comparator)	Sets new comparator only if current set is empty

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface org.redisson.api.RExpirable

clearExpire, expire, expire, expire, expireAt, expireAt, expireIfGreater, expireIfGreater, expireIfLess, expireIfLess, expireIfNotSet, expireIfNotSet, expireIfSet, expireIfSet, getExpireTime, remainTimeToLive

Methods inherited from interface org.redisson.api.RExpirableAsync

clearExpireAsync, expireAsync, expireAsync, expireAsync, expireAtAsync, expireAtAsync, expireIfGreaterAsync, expireIfGreaterAsync, expireIfLessAsync, expireIfLessAsync, expireIfNotSetAsync, expireIfNotSetAsync, expireIfSetAsync, expireIfSetAsync, getExpireTimeAsync, remainTimeToLiveAsync

Methods inherited from interface org.redisson.api.RObject

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

Methods inherited from interface org.redisson.api.RObjectAsync

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

Methods inherited from interface java.util.Set

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

Methods inherited from interface java.util.SortedSet

comparator, first, headSet, last, spliterator, subSet, tailSet

Method Details

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

readAll

Collection<V> readAll()

readAllAsync

RFuture<Collection<V>> readAllAsync()

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

pollFirst

Collection<V> pollFirst(int count)

Removes and returns the head elements of this sorted set.

Requires Redis 6.2.0 and higher.

Parameters:

count - - elements amount

Returns:

the head elements of this sorted set

pollFirst

V pollFirst(Duration duration)

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

Parameters:

duration - how long to wait before giving up

Returns:

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

pollFirst

List<V> pollFirst(Duration duration,
 int count)

Removes and returns the head elements.

Requires Redis 7.0.0 and higher.

Parameters:

duration - how long to wait before giving up

count - elements amount

Returns:

the head elements

pollFirstAsync

RFuture<V> pollFirstAsync()

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

pollFirstAsync

RFuture<Collection<V>> pollFirstAsync(int count)

Removes and returns the head elements of this sorted set.

Requires Redis 6.2.0 and higher.

Parameters:

count - - elements amount

Returns:

the head elements of this sorted set

pollFirstAsync

RFuture<V> pollFirstAsync(Duration duration)

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

Parameters:

duration - how long to wait before giving up

Returns:

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

pollFirstAsync

RFuture<List<V>> pollFirstAsync(Duration duration,
 int count)

Removes and returns the head elements.

Requires Redis 7.0.0 and higher.

Parameters:

duration - how long to wait before giving up

count - elements amount

Returns:

the head elements

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

pollLast

Collection<V> pollLast(int count)

Removes and returns the tail elements of this sorted set.

Requires Redis 6.2.0 and higher.

Parameters:

count - - elements amount

Returns:

the tail elements of this sorted set

pollLast

V pollLast(Duration duration)

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

Parameters:

duration - how long to wait before giving up

Returns:

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

pollLast

List<V> pollLast(Duration duration,
 int count)

Removes and returns the tail elements.

Requires Redis 7.0.0 and higher.

Parameters:

duration - how long to wait before giving up

count - elements amount

Returns:

the tail elements

pollLastAsync

RFuture<V> pollLastAsync()

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

pollLastAsync

RFuture<Collection<V>> pollLastAsync(int count)

Removes and returns the tail elements of this sorted set.

Requires Redis 6.2.0 and higher.

Parameters:

count - - elements amount

Returns:

the tail elements of this sorted set

pollLastAsync

RFuture<V> pollLastAsync(Duration duration)

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

Parameters:

duration - how long to wait before giving up

Returns:

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

pollLastAsync

RFuture<List<V>> pollLastAsync(Duration duration,
 int count)

Removes and returns the tail elements.

Requires Redis 7.0.0 and higher.

Parameters:

duration - how long to wait before giving up

count - elements amount

Returns:

the tail elements

addAsync

RFuture<Boolean> addAsync(V value)

removeAsync

RFuture<Boolean> removeAsync(Object value)

trySetComparator

boolean trySetComparator(Comparator<? super V> comparator)

Sets new comparator only if current set is empty

Parameters:

comparator - for values

Returns:

true if new comparator setted false otherwise

distributedIterator

Iterator<V> distributedIterator(int count)

Returns element iterator that can be shared across multiple applications. Creating multiple iterators on the same object with this method will result in a single shared iterator. See RList.distributedIterator(String, int) for creating different iterators.

Parameters:

count - batch size

Returns:

shared elements iterator

distributedIterator

Iterator<V> distributedIterator(String iteratorName,
 int count)

Returns iterator over elements that match specified pattern. Iterator can be shared across multiple applications. Creating multiple iterators on the same object with this method will result in a single shared iterator. Iterator name must be resolved to the same hash slot as list name.

Parameters:

iteratorName - redis object name to which cursor will be saved

count - batch size

Returns:

shared elements iterator