Package com.algolia.model.search

Class HighlightResultOption

java.lang.Object

com.algolia.model.search.HighlightResultOption

All Implemented Interfaces:

HighlightResult

public class HighlightResultOption
extends Object
implements HighlightResult

Surround words that match the query with HTML tags for highlighting.

Nested Class Summary

Nested classes/interfaces inherited from interface com.algolia.model.search.HighlightResult

HighlightResult.Deserializer, HighlightResult.ListOfHighlightResultWrapper, HighlightResult.MapOfStringHighlightResultWrapper

Constructor Summary

Constructors

Constructor	Description
HighlightResultOption()

Method Summary

Modifier and Type	Method	Description
HighlightResultOption	addMatchedWords(String matchedWordsItem)
boolean	equals(Object o)
Boolean	getFullyHighlighted()	Whether the entire attribute value is highlighted.
List<String>	getMatchedWords()	List of matched words from the search query.
MatchLevel	getMatchLevel()	Get matchLevel
String	getValue()	Highlighted attribute value, including HTML tags.
int	hashCode()
HighlightResultOption	setFullyHighlighted(Boolean fullyHighlighted)
HighlightResultOption	setMatchedWords(List<String> matchedWords)
HighlightResultOption	setMatchLevel(MatchLevel matchLevel)
HighlightResultOption	setValue(String value)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

HighlightResultOption

public HighlightResultOption()

Method Details

setValue

public HighlightResultOption setValue(String value)

getValue

@Nonnull
public String getValue()

Highlighted attribute value, including HTML tags.

setMatchLevel

public HighlightResultOption setMatchLevel(MatchLevel matchLevel)

getMatchLevel

@Nonnull
public MatchLevel getMatchLevel()

Get matchLevel

setMatchedWords

public HighlightResultOption setMatchedWords(List<String> matchedWords)

addMatchedWords

public HighlightResultOption addMatchedWords(String matchedWordsItem)

getMatchedWords

@Nonnull
public List<String> getMatchedWords()

List of matched words from the search query.

setFullyHighlighted

public HighlightResultOption setFullyHighlighted(Boolean fullyHighlighted)

getFullyHighlighted

@Nullable
public Boolean getFullyHighlighted()

Whether the entire attribute value is highlighted.

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