eu.isas.peptideshaker.cmd

Enum PathSettingsCLIParams

java.lang.Object

java.lang.Enum<PathSettingsCLIParams>

eu.isas.peptideshaker.cmd.PathSettingsCLIParams

All Implemented Interfaces:

Serializable, Comparable<PathSettingsCLIParams>

public enum PathSettingsCLIParams
extends Enum<PathSettingsCLIParams>

Enum of the command line parameters for path setting.

Author:

Marc Vaudel, Harald Barsnes

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL
LOG_FOLDER
USE_LOG_FOLDER

Field Summary

Fields

Modifier and Type	Field and Description
String	description The description of the command line option.
String	id The id of the command line option.

Method Summary

Modifier and Type	Method and Description
static void	createOptionsCLI(org.apache.commons.cli.Options aOptions) Creates the options for the command line interface based on the possible values.
static ArrayList<String>	getOptionIDs() Returns the list of supported command line options.
static String	getOptionsAsString() Returns the options as a string.
static PathSettingsCLIParams	valueOf(String name) Returns the enum constant of this type with the specified name.
static PathSettingsCLIParams[]	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

ALL

public static final PathSettingsCLIParams ALL

LOG_FOLDER

public static final PathSettingsCLIParams LOG_FOLDER

USE_LOG_FOLDER

public static final PathSettingsCLIParams USE_LOG_FOLDER

Field Detail

id

public String id

The id of the command line option.

description

public String description

The description of the command line option.

Method Detail

values

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

Returns:

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

valueOf

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

createOptionsCLI

public static void createOptionsCLI(org.apache.commons.cli.Options aOptions)

Creates the options for the command line interface based on the possible values.

Parameters:

aOptions - the options object where the options will be added

getOptionIDs

public static ArrayList<String> getOptionIDs()

Returns the list of supported command line options.

Returns:

the list of supported command line options

getOptionsAsString

public static String getOptionsAsString()

Returns the options as a string.

Returns:

the options as a string