org.hawkular.client.metrics.model

Enum Order

java.lang.Object

java.lang.Enum<Order>

org.hawkular.client.metrics.model.Order

All Implemented Interfaces:

Serializable, Comparable<Order>

public enum Order
extends Enum<Order>

https://github.com/hawkular/hawkular-metrics/blob/master/core/metrics-core-service/src/main/java/org/hawkular/metrics/core/service/Order.java

Author:

John Sanda

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASC
DESC

Method Summary

Modifier and Type	Method and Description
static Order	defaultValue(int limit, Object start, Object end) Determines a default value based on API parameters.
static Order	fromText(String text)
String	toString()
static Order	valueOf(String name) Returns the enum constant of this type with the specified name.
static Order[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ASC

public static final Order ASC

DESC

public static final Order DESC

Method Detail

values

public static 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 (Order c : 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 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 name

NullPointerException - if the argument is null

fromText

public static Order fromText(String text)

defaultValue

public static Order defaultValue(int limit,
                                 Object start,
                                 Object end)

Determines a default value based on API parameters.

Parameters:

limit - maximum of rows returned

start - time range start

end - time range end

Returns:

ASC if limit is positive, start is not null and end is null; DESC otherwise

toString

public String toString()

Overrides:

toString in class Enum<Order>