Package org.opendaylight.yangtools.yang.common

Enum Ordering

java.lang.Object

java.lang.Enum<Ordering>

org.opendaylight.yangtools.yang.common.Ordering

All Implemented Interfaces:

Serializable, Comparable<Ordering>

@NonNullByDefault
public enum Ordering
extends Enum<Ordering>

Item ordering, as specified by RFC7950 section 7.7.1.

Enum Constant Summary

Enum Constants

Enum Constant	Description
SYSTEM	The equivalent of ordered-by system.
USER	The equivalent of ordered-by user.

Method Summary

Modifier and Type	Method	Description
String	argument()	Return the {code ordered-by} string argument this Ordering represents.
static Ordering	forArgument(String argumentString)	Return the Ordering corresponding to an argument string.
static Ordering	valueOf(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

SYSTEM

public static final Ordering SYSTEM

The equivalent of ordered-by system.

USER

public static final Ordering USER

The equivalent of ordered-by user.

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(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

argument

public String argument()

Return the {code ordered-by} string argument this Ordering represents.

Returns:

Argument string

forArgument

public static Ordering forArgument(String argumentString)

Return the Ordering corresponding to an argument string.

Parameters:

argumentString - Argument string

Returns:

Corresponding Ordering

Throws:

NullPointerException - if {code argumentString} is null

IllegalArgumentException - if the argument string is not a valid Ordering