io.lettuce.core.search.arguments

Class SpellCheckArgs<K,V>

java.lang.Object

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

Type Parameters:

K - Key type.

V - Value type.

public class SpellCheckArgs<K,V>
extends Object

Argument list builder for the Redis FT.SPELLCHECK command. Static import methods are available.

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

Since:

6.8

Author:

Tihomir Mateev

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
SpellCheckArgs()

Method Summary

Modifier and Type	Method and Description
void	build(CommandArgs<K,V> args) Builds the arguments and appends them to the CommandArgs.
SpellCheckArgs<K,V>	dialect(long dialect) Set the dialect version under which to execute the query.
SpellCheckArgs<K,V>	distance(long distance) Set maximum Levenshtein distance for spelling suggestions (default: 1, max: 4).
SpellCheckArgs<K,V>	termsExclude(K dictionary, V... terms) Exclude terms from a custom dictionary from spelling suggestions.
SpellCheckArgs<K,V>	termsInclude(K dictionary, V... terms) Include terms from a custom dictionary as potential spelling suggestions.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpellCheckArgs

public SpellCheckArgs()

Method Detail

distance

public SpellCheckArgs<K,V> distance(long distance)

Set maximum Levenshtein distance for spelling suggestions (default: 1, max: 4).

Parameters:

distance - the maximum distance.

Returns:

this SpellCheckArgs.

dialect

public SpellCheckArgs<K,V> dialect(long dialect)

Set the dialect version under which to execute the query.

Parameters:

dialect - the dialect version.

Returns:

this SpellCheckArgs.

termsInclude

@SafeVarargs
public final SpellCheckArgs<K,V> termsInclude(K dictionary,
                                                           V... terms)

Include terms from a custom dictionary as potential spelling suggestions.

Parameters:

dictionary - the dictionary name.

terms - optional terms to include from the dictionary.

Returns:

this SpellCheckArgs.

termsExclude

@SafeVarargs
public final SpellCheckArgs<K,V> termsExclude(K dictionary,
                                                           V... terms)

Exclude terms from a custom dictionary from spelling suggestions.

Parameters:

dictionary - the dictionary name.

terms - optional terms to exclude from the dictionary.

Returns:

this SpellCheckArgs.

build

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

Builds the arguments and appends them to the CommandArgs.

Parameters:

args - the command arguments to append to.