Package org.redisson.api

Interface RLexSortedSetAsync

All Superinterfaces:

RCollectionAsync<String>, RExpirableAsync, RObjectAsync

All Known Subinterfaces:

RLexSortedSet

All Known Implementing Classes:

RedissonLexSortedSet

public interface RLexSortedSetAsync
extends RCollectionAsync<String>

Async interface for sorted set contained values of String type.

Author:

Nikita Koksharov

Method Summary

Modifier and Type	Method	Description
RFuture<Integer>	addListenerAsync(ObjectListener listener)	Adds object event listener
RFuture<Integer>	countAsync(String fromElement, boolean fromInclusive, String toElement, boolean toInclusive)	Returns the number of elements between fromElement and toElement.
RFuture<Integer>	countHeadAsync(String toElement, boolean toInclusive)	Returns the number of head values ending with toElement.
RFuture<Integer>	countTailAsync(String fromElement, boolean fromInclusive)	Returns the number of tail values starting with fromElement.
RFuture<String>	firstAsync()	Returns the first element.
RFuture<String>	lastAsync()	Returns the last element.
RFuture<String>	pollFirstAsync()	Removes and returns the head element or null if this sorted set is empty.
RFuture<String>	pollLastAsync()	Removes and returns the tail element or null if this sorted set is empty.
RFuture<String>	randomAsync()	Returns random element from this sorted set
RFuture<Collection<String>>	randomAsync(int count)	Returns random elements from this sorted set limited by count
RFuture<Collection<String>>	rangeAsync(int startIndex, int endIndex)	Returns values by rank range.
RFuture<Collection<String>>	rangeAsync(String fromElement, boolean fromInclusive, String toElement, boolean toInclusive)	Returns values range starting with fromElement and ending with toElement.
RFuture<Collection<String>>	rangeAsync(String fromElement, boolean fromInclusive, String toElement, boolean toInclusive, int offset, int count)	Returns values range starting with fromElement and ending with toElement.
RFuture<Collection<String>>	rangeHeadAsync(String toElement, boolean toInclusive)	Returns head values range ending with toElement.
RFuture<Collection<String>>	rangeHeadAsync(String toElement, boolean toInclusive, int offset, int count)	Returns head values range ending with toElement.
RFuture<Collection<String>>	rangeHeadReversedAsync(String toElement, boolean toInclusive)	Returns head values range in reverse order ending with toElement.
RFuture<Collection<String>>	rangeHeadReversedAsync(String toElement, boolean toInclusive, int offset, int count)	Returns head values range in reverse order ending with toElement.
RFuture<Collection<String>>	rangeReversedAsync(String fromElement, boolean fromInclusive, String toElement, boolean toInclusive)	Returns values range in reverse order starting with fromElement and ending with toElement.
RFuture<Collection<String>>	rangeReversedAsync(String fromElement, boolean fromInclusive, String toElement, boolean toInclusive, int offset, int count)	Returns values range in reverse order starting with fromElement and ending with toElement.
RFuture<Collection<String>>	rangeTailAsync(String fromElement, boolean fromInclusive)	Returns tail values range starting with fromElement.
RFuture<Collection<String>>	rangeTailAsync(String fromElement, boolean fromInclusive, int offset, int count)	Returns tail values range starting with fromElement.
RFuture<Collection<String>>	rangeTailReversedAsync(String fromElement, boolean fromInclusive)	Returns tail values range in reverse order starting with fromElement.
RFuture<Collection<String>>	rangeTailReversedAsync(String fromElement, boolean fromInclusive, int offset, int count)	Returns tail values range in reverse order starting with fromElement.
RFuture<Integer>	rankAsync(String o)	Returns rank of the element
RFuture<Collection<String>>	readAllAsync()	Read all values at once.
RFuture<Integer>	removeRangeAsync(String fromElement, boolean fromInclusive, String toElement, boolean toInclusive)	Removes values range starting with fromElement and ending with toElement.
RFuture<Integer>	removeRangeHeadAsync(String toElement, boolean toInclusive)	Removes head values range ending with toElement.
RFuture<Integer>	removeRangeTailAsync(String fromElement, boolean fromInclusive)	Removes tail values range starting with fromElement.
RFuture<Integer>	revRankAsync(String o)	Returns rank of value, with the scores ordered from high to low.

Methods inherited from interface org.redisson.api.RCollectionAsync

addAllAsync, addAsync, containsAllAsync, containsAsync, removeAllAsync, removeAsync, retainAllAsync, sizeAsync

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.RObjectAsync

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

Method Details

pollLastAsync

RFuture<String> 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

pollFirstAsync

RFuture<String> 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

firstAsync

RFuture<String> firstAsync()

Returns the first element.

Returns:

element

lastAsync

RFuture<String> lastAsync()

Returns the last element.

Returns:

element

readAllAsync

RFuture<Collection<String>> readAllAsync()

Read all values at once.

Returns:

collection of values

removeRangeAsync

RFuture<Integer> removeRangeAsync(String fromElement,
 boolean fromInclusive,
 String toElement,
 boolean toInclusive)

Removes values range starting with fromElement and ending with toElement.

Parameters:

fromElement - - start element

fromInclusive - - start element inclusive

toElement - - end element

toInclusive - - end element inclusive

Returns:

number of elements removed

removeRangeTailAsync

RFuture<Integer> removeRangeTailAsync(String fromElement,
 boolean fromInclusive)

Removes tail values range starting with fromElement.

Parameters:

fromElement - - start element

fromInclusive - - start element inclusive

Returns:

number of elements removed

removeRangeHeadAsync

RFuture<Integer> removeRangeHeadAsync(String toElement,
 boolean toInclusive)

Removes head values range ending with toElement.

Parameters:

toElement - - end element

toInclusive - - end element inclusive

Returns:

number of elements removed

countTailAsync

RFuture<Integer> countTailAsync(String fromElement,
 boolean fromInclusive)

Returns the number of tail values starting with fromElement.

Parameters:

fromElement - - start element

fromInclusive - - start element inclusive

Returns:

number of elements

countHeadAsync

RFuture<Integer> countHeadAsync(String toElement,
 boolean toInclusive)

Returns the number of head values ending with toElement.

Parameters:

toElement - - end element

toInclusive - - end element inclusive

Returns:

number of elements

rangeTailAsync

RFuture<Collection<String>> rangeTailAsync(String fromElement,
 boolean fromInclusive)

Returns tail values range starting with fromElement.

Parameters:

fromElement - - start element

fromInclusive - - start element inclusive

Returns:

collection of elements

rangeHeadAsync

RFuture<Collection<String>> rangeHeadAsync(String toElement,
 boolean toInclusive)

Returns head values range ending with toElement.

Parameters:

toElement - - end element

toInclusive - - end element inclusive

Returns:

collection of elements

rangeAsync

RFuture<Collection<String>> rangeAsync(String fromElement,
 boolean fromInclusive,
 String toElement,
 boolean toInclusive)

Returns values range starting with fromElement and ending with toElement.

Parameters:

fromElement - - start element

fromInclusive - - start element inclusive

toElement - - end element

toInclusive - - end element inclusive

Returns:

collection of elements

rangeTailAsync

RFuture<Collection<String>> rangeTailAsync(String fromElement,
 boolean fromInclusive,
 int offset,
 int count)

Returns tail values range starting with fromElement. Returned collection limited by count and starts with offset.

Parameters:

fromElement - - start element

fromInclusive - - start element inclusive

offset - - offset of result collection

count - - amount of result collection

Returns:

collection of elements

rangeHeadAsync

RFuture<Collection<String>> rangeHeadAsync(String toElement,
 boolean toInclusive,
 int offset,
 int count)

Returns head values range ending with toElement. Returned collection limited by count and starts with offset.

Parameters:

toElement - - end element

toInclusive - - end element inclusive

offset - - offset of result collection

count - - amount of result collection

Returns:

collection of elements

rangeAsync

RFuture<Collection<String>> rangeAsync(String fromElement,
 boolean fromInclusive,
 String toElement,
 boolean toInclusive,
 int offset,
 int count)

Returns values range starting with fromElement and ending with toElement. Returned collection limited by count and starts with offset.

Parameters:

fromElement - - start element

fromInclusive - - start element inclusive

toElement - - end element

toInclusive - - end element inclusive

offset - - offset of result collection

count - - amount of result collection

Returns:

collection of elements

rangeTailReversedAsync

RFuture<Collection<String>> rangeTailReversedAsync(String fromElement,
 boolean fromInclusive)

Returns tail values range in reverse order starting with fromElement.

Parameters:

fromElement - - start element

fromInclusive - - start element inclusive

Returns:

collection of elements

rangeHeadReversedAsync

RFuture<Collection<String>> rangeHeadReversedAsync(String toElement,
 boolean toInclusive)

Returns head values range in reverse order ending with toElement.

Parameters:

toElement - - end element

toInclusive - - end element inclusive

Returns:

collection of elements

rangeReversedAsync

RFuture<Collection<String>> rangeReversedAsync(String fromElement,
 boolean fromInclusive,
 String toElement,
 boolean toInclusive)

Returns values range in reverse order starting with fromElement and ending with toElement.

Parameters:

fromElement - - start element

fromInclusive - - start element inclusive

toElement - - end element

toInclusive - - end element inclusive

Returns:

collection of elements

rangeTailReversedAsync

RFuture<Collection<String>> rangeTailReversedAsync(String fromElement,
 boolean fromInclusive,
 int offset,
 int count)

Returns tail values range in reverse order starting with fromElement. Returned collection limited by count and starts with offset.

Parameters:

fromElement - - start element

fromInclusive - - start element inclusive

offset - - offset of result collection

count - - amount of result collection

Returns:

collection of elements

rangeHeadReversedAsync

RFuture<Collection<String>> rangeHeadReversedAsync(String toElement,
 boolean toInclusive,
 int offset,
 int count)

Returns head values range in reverse order ending with toElement. Returned collection limited by count and starts with offset.

Parameters:

toElement - - end element

toInclusive - - end element inclusive

offset - - offset of result collection

count - - amount of result collection

Returns:

collection of elements

rangeReversedAsync

RFuture<Collection<String>> rangeReversedAsync(String fromElement,
 boolean fromInclusive,
 String toElement,
 boolean toInclusive,
 int offset,
 int count)

Returns values range in reverse order starting with fromElement and ending with toElement. Returned collection limited by count and starts with offset.

Parameters:

fromElement - - start element

fromInclusive - - start element inclusive

toElement - - end element

toInclusive - - end element inclusive

offset - - offset of result collection

count - - amount of result collection

Returns:

collection of elements

countAsync

RFuture<Integer> countAsync(String fromElement,
 boolean fromInclusive,
 String toElement,
 boolean toInclusive)

Returns the number of elements between fromElement and toElement.

Parameters:

fromElement - - start element

fromInclusive - - start element inclusive

toElement - - end element

toInclusive - - end element inclusive

Returns:

number of elements

rankAsync

RFuture<Integer> rankAsync(String o)

Returns rank of the element

Parameters:

o - - element to rank

Returns:

rank or null if element does not exist

rangeAsync

RFuture<Collection<String>> rangeAsync(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:

collection of elements

revRankAsync

RFuture<Integer> revRankAsync(String o)

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

Parameters:

o - - value

Returns:

rank or null if value does not exist

randomAsync

RFuture<String> randomAsync()

Returns random element from this sorted set

Requires Redis 6.2.0 and higher.

Returns:

value

randomAsync

RFuture<Collection<String>> randomAsync(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:

value

addListenerAsync

RFuture<Integer> addListenerAsync(ObjectListener listener)

Adds object event listener

Specified by:

addListenerAsync in interface RObjectAsync

Parameters:

listener - object event listener

Returns:

listener id

See Also:

• TrackingListener
• ScoredSortedSetAddListener
• ScoredSortedSetRemoveListener
• ExpiredObjectListener
• DeletedObjectListener