io.lettuce.core.search

Class Suggestion<V>

java.lang.Object

io.lettuce.core.search.Suggestion<V>

Type Parameters:

V - Value type.

public class Suggestion<V>
extends Object

Represents a suggestion returned by the FT.SUGGET command.

A suggestion contains the suggestion string itself, and optionally a score and payload when the FT.SUGGET command is called with WITHSCORES and/or WITHPAYLOADS options.

Since:

6.8

Author:

Tihomir Mateev

Constructor Summary

Constructors

Constructor and Description
Suggestion(V value) Create a new suggestion with only the value.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
V	getPayload() Get the suggestion payload.
Double	getScore() Get the suggestion score.
V	getValue() Get the suggestion string.
int	hashCode()
boolean	hasPayload() Check if this suggestion has a payload.
boolean	hasScore() Check if this suggestion has a score.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Suggestion

public Suggestion(V value)

Create a new suggestion with only the value.

Parameters:

value - the suggestion string

Method Detail

getValue

public V getValue()

Get the suggestion string.

Returns:

the suggestion value

getScore

public Double getScore()

Get the suggestion score.

Returns:

the suggestion score, or null if not available

getPayload

public V getPayload()

Get the suggestion payload.

Returns:

the suggestion payload, or null if not available

hasScore

public boolean hasScore()

Check if this suggestion has a score.

Returns:

true if the suggestion has a score

hasPayload

public boolean hasPayload()

Check if this suggestion has a payload.

Returns:

true if the suggestion has a payload

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object