Package org.evoludo.util

Enum Class CLOption.Argument

Object

Enum<CLOption.Argument>

Argument

All Implemented Interfaces:

Serializable, Comparable<CLOption.Argument>, Constable

Enclosing class:

CLOption

public static enum CLOption.Argument
extends Enum<CLOption.Argument>

Types of command line options:

REQUIRED

required argument. Must be separated from command line option name by whitespace or '='.

OPTIONAL

optional argument. If present, must be separated from command line option name by whitespace or '='.

NONE

no argument.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
NONE	NONE: no argument.
OPTIONAL	OPTIONAL: optional argument.
REQUIRED	REQUIRED: required argument.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Argument()

Method Summary

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

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

REQUIRED

public static final CLOption.Argument REQUIRED

REQUIRED: required argument. Must be separated from command line option name by whitespace or '='.

OPTIONAL

public static final CLOption.Argument OPTIONAL

OPTIONAL: optional argument. If present, must be separated from command line option name by whitespace or '='.

NONE

public static final CLOption.Argument NONE

NONE: no argument.

Constructor Details

Argument

private Argument()

Method Details

values

public static CLOption.Argument[] 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 CLOption.Argument 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