Sortable (Hibernate Search 6.0.8.Final)

java.lang.Object
- java.lang.Enum<Sortable>
- - org.hibernate.search.engine.backend.types.Sortable

All Implemented Interfaces:

Serializable, Comparable<Sortable>
```
public enum Sortable
extends Enum<Sortable>
```
Whether a field can be used in sorts.

Author:

Emmanuel Bernard

Enum Constant Summary

Enum Constants
Enum Constant Description

DEFAULT
Use the backend-specific default.

NO
The field is not sortable.

YES
The field is sortable

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static Sortable`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static Sortable[]`	`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
  - DEFAULT
```
public static final Sortable DEFAULT
```
    Use the backend-specific default.
  - NO
```
public static final Sortable NO
```
    The field is not sortable.
  - YES
```
public static final Sortable YES
```
    The field is sortable
- Method Detail
  - values
```
public static Sortable[] 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 (Sortable c : Sortable.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Sortable 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