org.molgenis.util.cmdline

Enum Option.Type

java.lang.Object

java.lang.Enum<Option.Type>

org.molgenis.util.cmdline.Option.Type

All Implemented Interfaces:

Serializable, Comparable<Option.Type>

Enclosing class:

Option

public static enum Option.Type
extends Enum<Option.Type>

Describes the different types a command-line option can be. Based on this information the parser knows whether to look for an argument or not for the option.

Enum Constant Summary

Enum Constants

Enum Constant and Description
NO_ARGUMENT The option never has an argument (e.g.
OPTIONAL_ARGUMENT The option could have an argument (-o -p _or_ -o argument -p)
REQUIRED_ARGUMENT The option always has an argument (-o argument)

Method Summary

Methods

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

The option never has an argument (e.g. -o)

REQUIRED_ARGUMENT

public static final Option.Type REQUIRED_ARGUMENT

The option always has an argument (-o argument)

OPTIONAL_ARGUMENT

public static final Option.Type OPTIONAL_ARGUMENT

The option could have an argument (-o -p _or_ -o argument -p)

Method Detail

values

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

Returns:

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

valueOf

public static Option.Type 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