Package org.apache.lucene.search
Enum TotalHits.Relation
- All Implemented Interfaces:
Serializable
,Comparable<TotalHits.Relation>
- Enclosing class:
- TotalHits
How the
TotalHits.value
should be interpreted.-
Enum Constant Summary
Enum ConstantDescriptionThe total hit count is equal toTotalHits.value
.The total hit count is greater than or equal toTotalHits.value
. -
Method Summary
Modifier and TypeMethodDescriptionstatic TotalHits.Relation
Returns the enum constant of this type with the specified name.static TotalHits.Relation[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
EQUAL_TO
The total hit count is equal toTotalHits.value
. -
GREATER_THAN_OR_EQUAL_TO
The total hit count is greater than or equal toTotalHits.value
.
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified nameNullPointerException
- if the argument is null
-