io.lettuce.core.search.aggregateutils

Class SortProperty<K>

java.lang.Object

io.lettuce.core.search.aggregateutils.SortProperty<K>

Type Parameters:

K - Key type.

@Experimental
public class SortProperty<K>
extends Object

Represents a sort property with direction for SORTBY operations in FT.HYBRID and FT.AGGREGATE commands.

Since:

7.5

Author:

Aleksandar Todorov

See Also:

SortBy, SortDirection

Constructor Summary

Constructors

Constructor and Description
SortProperty(K property, SortDirection direction) Creates a new sort property.

Method Summary

Modifier and Type	Method and Description
SortDirection	getDirection() Get the sort direction.
K	getProperty() Get the property to sort by.
static <K> SortProperty<K>	of(K property, SortDirection direction) Static factory method to create a SortProperty instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

SortProperty

public SortProperty(K property,
                    SortDirection direction)

Creates a new sort property.

Parameters:

property - the property to sort by

direction - the sort direction

Method Detail

of

public static <K> SortProperty<K> of(K property,
                                     SortDirection direction)

Static factory method to create a SortProperty instance.

Type Parameters:

K - Key type

Parameters:

property - the property to sort by

direction - the sort direction

Returns:

new SortProperty instance

getProperty

public K getProperty()

Get the property to sort by.

Returns:

the property

getDirection

public SortDirection getDirection()

Get the sort direction.

Returns:

the sort direction