io.lettuce.core.search.arguments

Class HighlightArgs.Builder

java.lang.Object

io.lettuce.core.search.arguments.HighlightArgs.Builder

Enclosing class:

HighlightArgs

public static class HighlightArgs.Builder
extends Object

Builder for HighlightArgs.

As a final step the build() method needs to be executed to create the final SortByArgs instance.

See Also:

FT.CREATE

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
HighlightArgs	build() Build the HighlightArgs.
HighlightArgs.Builder	field(String field) Add a field to highlight.
HighlightArgs.Builder	tags(String startTag, String endTag) Tags to surround the matched terms with.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

field

public HighlightArgs.Builder field(String field)

Add a field to highlight. If no FIELDS directive is passed, then all returned fields are highlighted.

Parameters:

field - the field to summarize

Returns:

the instance of the current HighlightArgs.Builder for the purpose of method chaining

tags

public HighlightArgs.Builder tags(String startTag,
                                  String endTag)

Tags to surround the matched terms with. If no TAGS are specified, a built-in tag pair is prepended and appended to each matched term.

Parameters:

startTag - the string is prepended to each matched term

endTag - the string is appended to each matched term

Returns:

the instance of the current HighlightArgs.Builder for the purpose of method chaining

build

public HighlightArgs build()

Build the HighlightArgs.

Returns:

the HighlightArgs