io.lettuce.core

Class ZRange

java.lang.Object

io.lettuce.core.ZRange

public final class ZRange
extends Object

Range selectors for the Redis ZRANGE command. A selector couples the range boundaries with the range kind and carries the options that are legal for that kind:

• byIndex(long, long) selects members by position and supports REV.
• byScore(Range) selects members by score (BYSCORE) and supports REV and LIMIT.
• byLex(Range) selects members by lexicographical order (BYLEX) and supports REV and LIMIT. Lexicographical ranges cannot be combined with WITHSCORES.

Selectors copy the boundaries of the Range they are created from, so later modifications of that Range do not affect the selector. Selectors are mutable objects and instances should be used only once to avoid shared mutable state.

Since:

7.8

Author:

Yordan Tsintsov

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ZRange.ByIndex Selector for members by index.
static class	ZRange.ByLex<V> Selector for members by lexicographical order (BYLEX).
static class	ZRange.ByScore Selector for members by score (BYSCORE).

Method Summary

Modifier and Type	Method and Description
static ZRange.ByIndex	byIndex(long start, long stop) Create a selector for members by index.
static <V> ZRange.ByLex<V>	byLex(Range<V> range) Create a selector for members by lexicographical order.
static ZRange.ByScore	byScore(double min, double max) Create a selector for members by score.
static ZRange.ByScore	byScore(Range<? extends Number> range) Create a selector for members by score.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

byIndex

public static ZRange.ByIndex byIndex(long start,
                                     long stop)

Create a selector for members by index.

Parameters:

start - the start index.

stop - the stop index, inclusive.

Returns:

the ZRange.ByIndex selector for members between start and stop.

Since:

7.8

byScore

public static ZRange.ByScore byScore(Range<? extends Number> range)

Create a selector for members by score.

Parameters:

range - the score range, must not be null and must not contain NaN boundaries.

Returns:

the ZRange.ByScore selector for members with a score within range.

Since:

7.8

byScore

public static ZRange.ByScore byScore(double min,
                                     double max)

Create a selector for members by score.

Parameters:

min - the lower score boundary, inclusive.

max - the upper score boundary, inclusive.

Returns:

the ZRange.ByScore selector for members with a score between min and max.

Since:

7.8

byLex

public static <V> ZRange.ByLex<V> byLex(Range<V> range)

Create a selector for members by lexicographical order.

Type Parameters:

V - value type of the range boundaries.

Parameters:

range - the lexicographical range, must not be null.

Returns:

the ZRange.ByLex selector for members within range.

Since:

7.8