org.onosproject.store.service

Enum Ordering

java.lang.Object

java.lang.Enum<Ordering>

org.onosproject.store.service.Ordering

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Ordering>

public enum Ordering
extends java.lang.Enum<Ordering>

Describes the order of a primitive data structure.

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSERTION Indicates that items should be ordered in insertion order.
NATURAL Indicates that items should be ordered in their natural order.

Method Summary

Modifier and Type	Method and Description
static Ordering	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Ordering[]	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

NATURAL

public static final Ordering NATURAL

Indicates that items should be ordered in their natural order.

INSERTION

public static final Ordering INSERTION

Indicates that items should be ordered in insertion order.

Method Detail

values

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

Returns:

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

valueOf

public static Ordering valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null