Package org.springframework.data.redis.core

Class ScanOptions

java.lang.Object

org.springframework.data.redis.core.ScanOptions

Direct Known Subclasses:

KeyScanOptions

public class ScanOptions
extends Object

Options to be used for with SCAN commands.

Since:

1.4

Author:

Christoph Strobl, Thomas Darimont, Mark Paluch

See Also:

• KeyScanOptions

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ScanOptions.ScanOptionsBuilder

Field Summary

Fields

Modifier and Type	Field	Description
static ScanOptions	NONE	Constant to apply default ScanOptions without setting a limit or matching a pattern.

Method Summary

Modifier and Type	Method	Description
byte[]	getBytePattern()
Long	getCount()
String	getPattern()
static ScanOptions.ScanOptionsBuilder	scanOptions()	Static factory method that returns a new ScanOptions.ScanOptionsBuilder.
String	toOptionString()

Methods inherited from class java.lang.Object

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

Field Details

NONE

public static ScanOptions NONE

Constant to apply default ScanOptions without setting a limit or matching a pattern.

Method Details

scanOptions

public static ScanOptions.ScanOptionsBuilder scanOptions()

Static factory method that returns a new ScanOptions.ScanOptionsBuilder.

Returns:

getCount

@Nullable
public Long getCount()

getPattern

@Nullable
public String getPattern()

getBytePattern

@Nullable
public byte[] getBytePattern()

toOptionString

public String toOptionString()