com.lambdaworks.redis

Class ScanArgs

java.lang.Object

com.lambdaworks.redis.ScanArgs

public class ScanArgs
extends Object

Argument list builder for the Redis scan commands (SCAN, HSCAN, SSCAN, ZSCAN). Static import the methods from ScanArgs.Builder and chain the method calls: matches("weight_*").limit(0, 2).

ScanArgs is a mutable object and instances should be used only once to avoid shared mutable state.

Since:

3.0

Author:

Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScanArgs.Builder Builder entry points for ScanArgs.

Constructor Summary

Constructors

Constructor and Description
ScanArgs()

Method Summary

Modifier and Type	Method and Description
ScanArgs	limit(long count) Limit the scan by count
ScanArgs	match(String match) Set the match filter.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScanArgs

public ScanArgs()

Method Detail

match

public ScanArgs match(String match)

Set the match filter.

Parameters:

match - the filter, must not be null.

Returns:

this ScanArgs.

limit

public ScanArgs limit(long count)

Limit the scan by count

Parameters:

count - number of elements to scan

Returns:

this ScanArgs.