io.lettuce.core.search.arguments

Class SortByArgs.Builder<K>

java.lang.Object

io.lettuce.core.search.arguments.SortByArgs.Builder<K>

Type Parameters:

K - the key type

Enclosing class:

SortByArgs<K>

public static class SortByArgs.Builder<K>
extends Object

Builder for SortByArgs.

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
SortByArgs.Builder<K>	attribute(K attribute) Add an attribute to sort by.
SortByArgs<K>	build() Build the SortByArgs.
SortByArgs.Builder<K>	descending() Sort in descending order.
SortByArgs.Builder<K>	withCount() Include the accurate counts for the query results with sorting.

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

attribute

public SortByArgs.Builder<K> attribute(K attribute)

Add an attribute to sort by.

Parameters:

attribute - the attribute to sort by

Returns:

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

descending

public SortByArgs.Builder<K> descending()

Sort in descending order. Default is ascending.

Returns:

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

withCount

public SortByArgs.Builder<K> withCount()

Include the accurate counts for the query results with sorting. Default is disabled.

Returns:

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

build

public SortByArgs<K> build()

Build the SortByArgs.

Returns:

the SortByArgs