org.elasticsearch.search.facet.histogram
Enum HistogramFacet.ComparatorType

java.lang.Object
  java.lang.Enum<HistogramFacet.ComparatorType>
      org.elasticsearch.search.facet.histogram.HistogramFacet.ComparatorType

All Implemented Interfaces:

Serializable, Comparable<HistogramFacet.ComparatorType>

Enclosing interface:

HistogramFacet

public static enum HistogramFacet.ComparatorType
extends Enum<HistogramFacet.ComparatorType>

Enum Constant Summary

COUNT

KEY

TOTAL

Method Summary

Comparator<HistogramFacet.Entry>	comparator()
String	description()
static HistogramFacet.ComparatorType	fromId(byte id)
static HistogramFacet.ComparatorType	fromString(String type)
byte	id()
static HistogramFacet.ComparatorType	valueOf(String name) Returns the enum constant of this type with the specified name.
static HistogramFacet.ComparatorType[]	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

KEY

public static final HistogramFacet.ComparatorType KEY

COUNT

public static final HistogramFacet.ComparatorType COUNT

TOTAL

public static final HistogramFacet.ComparatorType TOTAL

Method Detail

values

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

Returns:

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

valueOf

public static HistogramFacet.ComparatorType 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

id

public byte id()

description

public String description()

comparator

public Comparator<HistogramFacet.Entry> comparator()

fromId

public static HistogramFacet.ComparatorType fromId(byte id)

fromString

public static HistogramFacet.ComparatorType fromString(String type)