Package io.vanslog.spring.data.meilisearch.core

Enum Class TotalHitsRelation

java.lang.Object

java.lang.Enum<TotalHitsRelation>

io.vanslog.spring.data.meilisearch.core.TotalHitsRelation

All Implemented Interfaces:

Serializable, Comparable<TotalHitsRelation>, Constable

public enum TotalHitsRelation
extends Enum<TotalHitsRelation>

Relation that describes how SearchHits.getTotalHits() relates to the total matching result set.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EQUAL_TO	The total hit count is equal to the total matching result set reported by the search engine.
OFF	Total hit metadata is unavailable.

Method Summary

Modifier and Type	Method	Description
static TotalHitsRelation	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TotalHitsRelation[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

EQUAL_TO

public static final TotalHitsRelation EQUAL_TO

The total hit count is equal to the total matching result set reported by the search engine.

OFF

public static final TotalHitsRelation OFF

Total hit metadata is unavailable.

Method Details

values

public static TotalHitsRelation[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static TotalHitsRelation valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null