name.kevinlocke.ultragetopt
Enum ArgumentDisposition

java.lang.Object
  java.lang.Enum<ArgumentDisposition>
      name.kevinlocke.ultragetopt.ArgumentDisposition

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ArgumentDisposition>

public enum ArgumentDisposition
extends java.lang.Enum<ArgumentDisposition>

Argument requirement status for options. These enumerants describe the argument requirements for a given option.

Enum Constant Summary

NO_ARGUMENT
Option does not take an argument.

OPTIONAL_ARGUMENT
Option may take an argument, but no argument is required.

REQUIRED_ARGUMENT
Option requires an argument, will cause error if none is present.

Method Summary

static ArgumentDisposition	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ArgumentDisposition[]	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

NO_ARGUMENT

public static final ArgumentDisposition NO_ARGUMENT

Option does not take an argument.

OPTIONAL_ARGUMENT

public static final ArgumentDisposition OPTIONAL_ARGUMENT

Option may take an argument, but no argument is required.

REQUIRED_ARGUMENT

public static final ArgumentDisposition REQUIRED_ARGUMENT

Option requires an argument, will cause error if none is present.

Method Detail

values

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

Returns:

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

valueOf

public static ArgumentDisposition valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null