Package org.moeaframework.util.cli

Enum Class OptionStyle

java.lang.Object

java.lang.Enum<OptionStyle>

org.moeaframework.util.cli.OptionStyle

All Implemented Interfaces:

Serializable, Comparable<OptionStyle>, Constable

public enum OptionStyle
extends Enum<OptionStyle>

Determines how options are styled when displaying a usage string for a command line utility.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	Displays all options, with non-required options surrounded by "[" and "]".
NONE	No individual options are displayed, only the catch-all "[options]".
REQUIRED_ONLY	Displays only required options.

Method Summary

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

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final OptionStyle NONE

No individual options are displayed, only the catch-all "[options]".

REQUIRED_ONLY

public static final OptionStyle REQUIRED_ONLY

Displays only required options.

ALL

public static final OptionStyle ALL

Displays all options, with non-required options surrounded by "[" and "]".

Method Details

values

public static OptionStyle[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static OptionStyle valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null