org.elasticsearch.common.util

Enum Comparators

java.lang.Object

java.lang.Enum<Comparators>

org.elasticsearch.common.util.Comparators

All Implemented Interfaces:

Serializable, Comparable<Comparators>

public enum Comparators
extends Enum<Comparators>

Comparator-related utility methods.

Method Summary

Modifier and Type	Method and Description
static int	compareDiscardNaN(double d1, double d2, boolean asc) Compare d1 against d2, pushing at the bottom.
static Comparators	valueOf(String name) Returns the enum constant of this type with the specified name.
static Comparators[]	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

Method Detail

values

public static Comparators[] 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 (Comparators c : Comparators.values())
    System.out.println(c);

Returns:

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

valueOf

public static Comparators 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

compareDiscardNaN

public static int compareDiscardNaN(double d1,
                                    double d2,
                                    boolean asc)

Compare d1 against d2, pushing at the bottom.