PartialList.Relation (Apache Unomi :: Root Project 2.5.1-SNAPSHOT API)

java.lang.Object
- java.lang.Enum<PartialList.Relation>
- - org.apache.unomi.api.PartialList.Relation

All Implemented Interfaces:

Serializable, Comparable<PartialList.Relation>

Enclosing class:

PartialList<T>
```
public static enum PartialList.Relation
extends Enum<PartialList.Relation>
```
This enum exists to replicate Lucene's total hits relation in a back-end agnostic way. Basically Lucene will by default not report accurate total hit counts above a certain threshold for performance reasons. Using the relation we can understand if we are in the case of an accurate hit or not.

Enum Constant Summary

Enum Constants
Enum Constant Description

EQUAL

GREATER_THAN_OR_EQUAL_TO

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static PartialList.Relation`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static PartialList.Relation[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - EQUAL
```
public static final PartialList.Relation EQUAL
```
  - GREATER_THAN_OR_EQUAL_TO
```
public static final PartialList.Relation GREATER_THAN_OR_EQUAL_TO
```
- Method Detail
  - values
```
public static PartialList.Relation[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (PartialList.Relation c : PartialList.Relation.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static PartialList.Relation valueOf(String name)
```
    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 name
    
    NullPointerException - if the argument is null