util
Enum CommandLineParser.OptionSpec.ArgSpec

java.lang.Object
  java.lang.Enum<CommandLineParser.OptionSpec.ArgSpec>
      util.CommandLineParser.OptionSpec.ArgSpec

All Implemented Interfaces:

Serializable, Comparable<CommandLineParser.OptionSpec.ArgSpec>

Enclosing interface:

CommandLineParser.OptionSpec<Cxt>

public static enum CommandLineParser.OptionSpec.ArgSpec
extends Enum<CommandLineParser.OptionSpec.ArgSpec>

The specification for the argument of an option. There are three kinds of objects: those that never take an argument, those that always do, and those that can take an optional argument.

Enum Constant Summary

NONE
Specifies that the option takes no argument.

OPTIONAL
Specifies that the option takes an argument, which has a default value.

REQUIRED
Specifies that the option must take an argument.

Method Summary

static CommandLineParser.OptionSpec.ArgSpec	valueOf(String name) Returns the enum constant of this type with the specified name.
static CommandLineParser.OptionSpec.ArgSpec[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final CommandLineParser.OptionSpec.ArgSpec NONE

Specifies that the option takes no argument.

REQUIRED

public static final CommandLineParser.OptionSpec.ArgSpec REQUIRED

Specifies that the option must take an argument.

OPTIONAL

public static final CommandLineParser.OptionSpec.ArgSpec OPTIONAL

Specifies that the option takes an argument, which has a default value.

Method Detail

values

public static final CommandLineParser.OptionSpec.ArgSpec[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(CommandLineParser.OptionSpec.ArgSpec c : CommandLineParser.OptionSpec.ArgSpec.values())
        System.out.println(c);

Returns:

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

valueOf

public static CommandLineParser.OptionSpec.ArgSpec 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