com.lexicalscope.jewel.cli

Enum OptionOrder

java.lang.Object

java.lang.Enum<OptionOrder>

com.lexicalscope.jewel.cli.OptionOrder

All Implemented Interfaces:

Serializable, Comparable<OptionOrder>

public enum OptionOrder
extends Enum<OptionOrder>

Defines the order that the options will be displayed in

Author:

tim

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFINITION display the options in the order that the reflection API returns them
LEXICOGRAPHIC display the options in alphabetical order

Method Summary

Methods

Modifier and Type	Method and Description
static OptionOrder	valueOf(String name) Returns the enum constant of this type with the specified name.
static OptionOrder[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LEXICOGRAPHIC

public static final OptionOrder LEXICOGRAPHIC

display the options in alphabetical order

DEFINITION

public static final OptionOrder DEFINITION

display the options in the order that the reflection API returns them

Method Detail

values

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

Returns:

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

valueOf

public static OptionOrder 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