Package org.apache.lucene.util
Enum LongHeap.Order
- java.lang.Object
-
- java.lang.Enum<LongHeap.Order>
-
- org.apache.lucene.util.LongHeap.Order
-
- All Implemented Interfaces:
Serializable
,Comparable<LongHeap.Order>
- Enclosing class:
- LongHeap
public static enum LongHeap.Order extends Enum<LongHeap.Order>
Used to specify the ordering of the heap. A min-heap provides access to the minimum element in constant time, and when bounded, retains the maximummaxSize
elements. A max-heap conversely provides access to the maximum element in constant time, and when bounded retains the minimummaxSize
elements.
-
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static LongHeap.Order
valueOf(String name)
Returns the enum constant of this type with the specified name.static LongHeap.Order[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
MIN
public static final LongHeap.Order MIN
-
MAX
public static final LongHeap.Order MAX
-
-
Method Detail
-
values
public static LongHeap.Order[] 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 (LongHeap.Order c : LongHeap.Order.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static LongHeap.Order 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 nameNullPointerException
- if the argument is null
-
-