fr.cnes.dynvol.gentleman.enums

Enum GtmCommandLineOpt

java.lang.Object

java.lang.Enum<GtmCommandLineOpt>

fr.cnes.dynvol.gentleman.enums.GtmCommandLineOpt

All Implemented Interfaces:

Serializable, Comparable<GtmCommandLineOpt>

public enum GtmCommandLineOpt
extends Enum<GtmCommandLineOpt>

Enumeration of available options

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEBUG Activating the progress bar option
HELP Help option
INPUT Using a XML file as input
OUTPUT_DIR Results directory
OUTPUT_NAME Archiving results options
PROGRESS Activating the progress bar option

Method Summary

Modifier and Type	Method and Description
String	getLongName() Get the long name of the option.
String	getName() Get the name of the option.
org.apache.commons.cli.Option	getOption() Return the configured option.
static GtmCommandLineOpt	valueOf(String name) Returns the enum constant of this type with the specified name.
static GtmCommandLineOpt[]	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

HELP

public static final GtmCommandLineOpt HELP

Help option

INPUT

public static final GtmCommandLineOpt INPUT

Using a XML file as input

OUTPUT_NAME

public static final GtmCommandLineOpt OUTPUT_NAME

Archiving results options

OUTPUT_DIR

public static final GtmCommandLineOpt OUTPUT_DIR

Results directory

PROGRESS

public static final GtmCommandLineOpt PROGRESS

Activating the progress bar option

DEBUG

public static final GtmCommandLineOpt DEBUG

Activating the progress bar option

Method Detail

values

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

Returns:

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

valueOf

public static GtmCommandLineOpt 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

getName

public String getName()

Get the name of the option.

Returns:

the name of the option.

getLongName

public String getLongName()

Get the long name of the option.

Returns:

the long name of the option.

getOption

public org.apache.commons.cli.Option getOption()

Return the configured option.

Returns:

the configured option.