Package org.springframework.data.redis.core

Class ScanOptions.ScanOptionsBuilder

java.lang.Object

org.springframework.data.redis.core.ScanOptions.ScanOptionsBuilder

Enclosing class:

ScanOptions

public static class ScanOptions.ScanOptionsBuilder
extends Object

Since:

1.4

Author:

Christoph Strobl, Mark Paluch

Method Summary

Modifier and Type	Method	Description
ScanOptions	build()	Builds a new ScanOptions objects.
ScanOptions.ScanOptionsBuilder	count(long count)	Returns the current ScanOptions.ScanOptionsBuilder configured with the given count.
ScanOptions.ScanOptionsBuilder	match(byte[] pattern)	Returns the current ScanOptions.ScanOptionsBuilder configured with the given pattern.
ScanOptions.ScanOptionsBuilder	match(String pattern)	Returns the current ScanOptions.ScanOptionsBuilder configured with the given pattern.
ScanOptions.ScanOptionsBuilder	type(String type)	Returns the current ScanOptions.ScanOptionsBuilder configured with the given type.
ScanOptions.ScanOptionsBuilder	type(DataType type)	Returns the current ScanOptions.ScanOptionsBuilder configured with the given type.

Methods inherited from class java.lang.Object

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

Method Details

count

public ScanOptions.ScanOptionsBuilder count(long count)

Returns the current ScanOptions.ScanOptionsBuilder configured with the given count.

Parameters:

count -

Returns:

this.

match

public ScanOptions.ScanOptionsBuilder match(String pattern)

Returns the current ScanOptions.ScanOptionsBuilder configured with the given pattern.

Parameters:

pattern -

Returns:

this.

match

public ScanOptions.ScanOptionsBuilder match(byte[] pattern)

Returns the current ScanOptions.ScanOptionsBuilder configured with the given pattern.

Parameters:

pattern -

Returns:

this.

Since:

2.6

type

public ScanOptions.ScanOptionsBuilder type(DataType type)

Returns the current ScanOptions.ScanOptionsBuilder configured with the given type.
Please verify the the targeted command supports the TYPE option before use.

Parameters:

type - must not be null. Either do not set or use DataType.NONE.

Returns:

this.

Since:

2.6

type

public ScanOptions.ScanOptionsBuilder type(String type)

Returns the current ScanOptions.ScanOptionsBuilder configured with the given type.

Parameters:

type - the textual representation of DataType.fromCode(String). Must not be null.

Returns:

this.

Throws:

IllegalArgumentException - if given type is null or unknown.

build

public ScanOptions build()

Builds a new ScanOptions objects.

Returns:

a new ScanOptions objects.