org.apache.flink.api.common.operators

Enum Order

java.lang.Object

java.lang.Enum<Order>

org.apache.flink.api.common.operators.Order

All Implemented Interfaces:

Serializable, Comparable<Order>

@Public
public enum Order
extends Enum<Order>

Enumeration representing order. May represent no order, an ascending order or a descending order.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANY Indicates an order without a direction.
ASCENDING Indicates an ascending order.
DESCENDING Indicates a descending order.
NONE Indicates no order.

Method Summary

Modifier and Type	Method and Description
String	getShortName()
boolean	isOrdered() Checks, if this enum constant represents in fact an order.
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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final Order NONE

Indicates no order.

ASCENDING

public static final Order ASCENDING

Indicates an ascending order.

DESCENDING

public static final Order DESCENDING

Indicates a descending order.

ANY

public static final Order ANY

Indicates an order without a direction. This constant is not used to indicate any existing order, but for example to indicate that an order of any direction is desirable.

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

isOrdered

public boolean isOrdered()

Checks, if this enum constant represents in fact an order. That is, whether this property is not equal to Order.NONE.

Returns:

True, if this enum constant is unequal to Order.NONE, false otherwise.

getShortName

public String getShortName()