io.lettuce.core.search.aggregateutils

Class Limit

java.lang.Object

io.lettuce.core.search.aggregateutils.Limit

All Implemented Interfaces:

PostProcessingOperation

@Experimental
public class Limit
extends Object
implements PostProcessingOperation

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<?,?> args) Build the operation arguments into the command args.
long	getNum() Get the number of results.
long	getOffset() Get the offset.
static Limit	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 Limit of(long offset,
                       long num)

Static factory method to create a Limit instance.

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<?,?> args)

Description copied from interface: PostProcessingOperation

Build the operation arguments into the command args.

Specified by:

build in interface PostProcessingOperation

Parameters:

args - the command args to build into