io.lettuce.core.search.aggregateutils

Class Limit<K,V>

java.lang.Object

io.lettuce.core.search.aggregateutils.Limit<K,V>

Type Parameters:

K - Key type.

V - Value type.

All Implemented Interfaces:

PostProcessingOperation<K,V>

@Experimental
public class Limit<K,V>
extends Object
implements PostProcessingOperation<K,V>

LIMIT post-processing operation. Limits the number of results for pagination.

Example Usage:

 
 {
     @code
     // Get first 10 results
     Limit limit = Limit.of(0, 10);

     // Get results 50-100
     Limit paginated = Limit.of(50, 50);
 }
 

Since:

7.5

Author:

Aleksandar Todorov

See Also:

PostProcessingOperation

Constructor Summary

Constructors

Constructor and Description
Limit(long offset, long num) Creates a new LIMIT operation.

Method Summary

Modifier and Type	Method and Description
void	build(CommandArgs<K,V> args) Build the operation arguments into the command args.
long	getNum() Get the number of results.
long	getOffset() Get the offset.
static <K,V> Limit<K,V>	of(long offset, long num) Static factory method to create a Limit instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

Limit

public Limit(long offset,
             long num)

Creates a new LIMIT operation.

Parameters:

offset - the zero-based starting index

num - the maximum number of results to return

Method Detail

of

public static <K,V> Limit<K,V> of(long offset,
                                  long num)

Static factory method to create a Limit instance.

Type Parameters:

K - Key type

V - Value type

Parameters:

offset - the zero-based starting index

num - the maximum number of results to return

Returns:

new Limit instance

getOffset

public long getOffset()

Get the offset.

Returns:

the offset

getNum

public long getNum()

Get the number of results.

Returns:

the number of results

build

public void build(CommandArgs<K,V> args)

Description copied from interface: PostProcessingOperation

Build the operation arguments into the command args.

Specified by:

build in interface PostProcessingOperation<K,V>

Parameters:

args - the command args to build into