net.thevpc.nuts.boot.internal.cmdline

Enum NBootOptionSpec.Arity

java.lang.Object

java.lang.Enum<NBootOptionSpec.Arity>

net.thevpc.nuts.boot.internal.cmdline.NBootOptionSpec.Arity

All Implemented Interfaces:

Serializable, Comparable<NBootOptionSpec.Arity>

Enclosing class:

NBootOptionSpec

public static enum NBootOptionSpec.Arity
extends Enum<NBootOptionSpec.Arity>

Enum Constant Summary

Enum Constants

Enum Constant and Description
FLAG Boolean toggle.
OPTIONAL_VALUE Value is optional and, if present, must be attached via '='.
TERMINAL Once matched, everything remaining belongs to the delegated command/app — out of nuts' own completion scope.
VALUE Requires a value: attached via '=' in the same token, or read from the next token if not attached.

Method Summary

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

FLAG

public static final NBootOptionSpec.Arity FLAG

Boolean toggle. Never consumes a separate following token.

VALUE

public static final NBootOptionSpec.Arity VALUE

Requires a value: attached via '=' in the same token, or read from the next token if not attached.

OPTIONAL_VALUE

public static final NBootOptionSpec.Arity OPTIONAL_VALUE

Value is optional and, if present, must be attached via '='. Never consumes a following token.

TERMINAL

public static final NBootOptionSpec.Arity TERMINAL

Once matched, everything remaining belongs to the delegated command/app — out of nuts' own completion scope.

Method Detail

values

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

Returns:

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

valueOf

public static NBootOptionSpec.Arity 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