io.lettuce.core.search.arguments

Class SearchArgs<K,V>

java.lang.Object

io.lettuce.core.search.arguments.SearchArgs<K,V>

Type Parameters:

K - Key type.

V - Value type.

public class SearchArgs<K,V>
extends Object

Argument list builder for FT.SEARCH.

Since:

6.8

Author:

Tihomir Mateev

See Also:

FT.SEARCH

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchArgs.Builder<K,V> Builder for SearchArgs.

Constructor Summary

Constructors

Constructor and Description
SearchArgs()

Method Summary

Modifier and Type	Method and Description
void	build(CommandArgs<K,V> args) Build a CommandArgs object that contains all the arguments.
static <K,V> SearchArgs.Builder<K,V>	builder() Used to build a new instance of the SearchArgs.
boolean	isNoContent() Gets whether the NOCONTENT option is enabled.
boolean	isWithScores() Gets whether the WITHSCORES option is enabled.
boolean	isWithSortKeys() Gets whether the WITHSORTKEYS option is enabled.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchArgs

public SearchArgs()

Method Detail

builder

public static <K,V> SearchArgs.Builder<K,V> builder()

Used to build a new instance of the SearchArgs.

Type Parameters:

K - the key type

V - the value type

Returns:

a SearchArgs.Builder that provides the option to build up a new instance of the SearchArgs

isNoContent

public boolean isNoContent()

Gets whether the NOCONTENT option is enabled.

Returns:

true if NOCONTENT is enabled, false otherwise

isWithScores

public boolean isWithScores()

Gets whether the WITHSCORES option is enabled.

Returns:

true if WITHSCORES is enabled, false otherwise

isWithSortKeys

public boolean isWithSortKeys()

Gets whether the WITHSORTKEYS option is enabled.

Returns:

true if WITHSORTKEYS is enabled, false otherwise

build

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

Build a CommandArgs object that contains all the arguments.

Parameters:

args - the CommandArgs object