Package org.redisson.api

Interface RLexSortedSet

All Superinterfaces:

Collection<String>, Iterable<String>, RCollectionAsync<String>, RExpirable, RExpirableAsync, RLexSortedSetAsync, RObject, RObjectAsync, RSortedSet<String>, Set<String>, SortedSet<String>

All Known Implementing Classes:

RedissonLexSortedSet

public interface RLexSortedSet
extends RLexSortedSetAsync, RSortedSet<String>, RExpirable

Sorted set contained values of String type

Author:

Nikita Koksharov

Method Summary

Modifier and Type	Method	Description
int	count(String fromElement, boolean fromInclusive, String toElement, boolean toInclusive)	Returns the number of elements between fromElement and toElement.
int	countHead(String toElement, boolean toInclusive)	Returns the number of head values ending with toElement.
int	countTail(String fromElement, boolean fromInclusive)	Returns the number of tail values starting with fromElement.
String	pollFirst()	Removes and returns the head element or null if this sorted set is empty.
String	pollLast()	Removes and returns the tail element or null if this sorted set is empty.
Collection<String>	range(int startIndex, int endIndex)	Returns values by rank range.
Collection<String>	range(String fromElement, boolean fromInclusive, String toElement, boolean toInclusive)	Returns values range starting with fromElement and ending with toElement.
Collection<String>	range(String fromElement, boolean fromInclusive, String toElement, boolean toInclusive, int offset, int count)	Returns values range starting with fromElement and ending with toElement.
Collection<String>	rangeHead(String toElement, boolean toInclusive)	Returns head values range ending with toElement.
Collection<String>	rangeHead(String toElement, boolean toInclusive, int offset, int count)	Returns head values range ending with toElement.
Collection<String>	rangeHeadReversed(String toElement, boolean toInclusive)	Returns head values range in reverse order ending with toElement.
Collection<String>	rangeHeadReversed(String toElement, boolean toInclusive, int offset, int count)	Returns head values range in reverse order ending with toElement.
Collection<String>	rangeReversed(String fromElement, boolean fromInclusive, String toElement, boolean toInclusive)	Returns values range in reverse order starting with fromElement and ending with toElement.
Collection<String>	rangeReversed(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.
Collection<String>	rangeTail(String fromElement, boolean fromInclusive)	Returns tail values range starting with fromElement.
Collection<String>	rangeTail(String fromElement, boolean fromInclusive, int offset, int count)	Returns tail values range starting with fromElement.
Collection<String>	rangeTailReversed(String fromElement, boolean fromInclusive)	Returns tail values range in reverse order starting with fromElement.
Collection<String>	rangeTailReversed(String fromElement, boolean fromInclusive, int offset, int count)	Returns tail values range in reverse order starting with fromElement.
Integer	rank(String o)	Returns rank of the element
int	removeRange(String fromElement, boolean fromInclusive, String toElement, boolean toInclusive)	Removes values range starting with fromElement and ending with toElement.
int	removeRangeHead(String toElement, boolean toInclusive)	Removes head values range ending with toElement.
int	removeRangeTail(String fromElement, boolean fromInclusive)	Removes tail values range starting with fromElement.
Integer	revRank(String o)	Returns rank of value, with the scores ordered from high to low.

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface org.redisson.api.RCollectionAsync

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

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

countAsync, countHeadAsync, countTailAsync, firstAsync, lastAsync, pollFirstAsync, pollLastAsync, rangeAsync, rangeAsync, rangeAsync, rangeHeadAsync, rangeHeadAsync, rangeHeadReversedAsync, rangeHeadReversedAsync, rangeReversedAsync, rangeReversedAsync, rangeTailAsync, rangeTailAsync, rangeTailReversedAsync, rangeTailReversedAsync, rankAsync, readAllAsync, removeRangeAsync, removeRangeHeadAsync, removeRangeTailAsync, revRankAsync

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

addAsync, distributedIterator, distributedIterator, mapReduce, readAll, readAllAsync, removeAsync, trySetComparator

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 Detail

pollFirst

String 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

String 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

revRank

Integer revRank(String 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

removeRangeTail

int removeRangeTail(String fromElement,
                    boolean fromInclusive)

Removes tail values range starting with fromElement.

Parameters:

fromElement - - start element

fromInclusive - - start element inclusive

Returns:

number of elements removed

removeRangeHead

int removeRangeHead(String toElement,
                    boolean toInclusive)

Removes head values range ending with toElement.

Parameters:

toElement - - end element

toInclusive - - end element inclusive

Returns:

number of elements removed

removeRange

int removeRange(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

countTail

int countTail(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

countHead

int countHead(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

rangeTail

Collection<String> rangeTail(String fromElement,
                             boolean fromInclusive)

Returns tail values range starting with fromElement.

Parameters:

fromElement - - start element

fromInclusive - - start element inclusive

Returns:

collection of elements

rangeHead

Collection<String> rangeHead(String toElement,
                             boolean toInclusive)

Returns head values range ending with toElement.

Parameters:

toElement - - end element

toInclusive - - end element inclusive

Returns:

collection of elements

range

Collection<String> range(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

rangeTail

Collection<String> rangeTail(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

rangeHead

Collection<String> rangeHead(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

range

Collection<String> range(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

rangeTailReversed

Collection<String> rangeTailReversed(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

rangeHeadReversed

Collection<String> rangeHeadReversed(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

rangeReversed

Collection<String> rangeReversed(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

rangeTailReversed

Collection<String> rangeTailReversed(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

rangeHeadReversed

Collection<String> rangeHeadReversed(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

rangeReversed

Collection<String> rangeReversed(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

count

int count(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

rank

Integer rank(String o)

Returns rank of the element

Parameters:

o - - element to rank

Returns:

rank or null if element does not exist

range

Collection<String> range(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