io.lettuce.core.search.arguments

Class HighlightArgs<K,V>

java.lang.Object

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

Type Parameters:

K - Key type.

V - Value type.

public class HighlightArgs<K,V>
extends Object

Argument list builder for HIGHLIGHT clause.

Since:

6.8

Author:

Tihomir Mateev

See Also:

Highlighting

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
HighlightArgs()

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> HighlightArgs.Builder<K,V>	builder() Used to build a new instance of the HighlightArgs.

Methods inherited from class java.lang.Object

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

Constructor Detail

HighlightArgs

public HighlightArgs()

Method Detail

builder

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

Used to build a new instance of the HighlightArgs.

Type Parameters:

K - the key type

Returns:

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

build

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

Build a CommandArgs object that contains all the arguments.

Parameters:

args - the CommandArgs object