eu.isas.peptideshaker.cmd

Enum ReportCLIParams

java.lang.Object

java.lang.Enum<ReportCLIParams>

eu.isas.peptideshaker.cmd.ReportCLIParams

All Implemented Interfaces:

Serializable, Comparable<ReportCLIParams>

public enum ReportCLIParams
extends Enum<ReportCLIParams>

This class provides the available reports as command line parameters.

Author:

Marc Vaudel, Harald Barsnes

Enum Constant Summary

Enum Constants

Enum Constant and Description
DOCUMENTATION_TYPE
EXPORT_FOLDER
EXPORT_PREFIX
GZIP
PSDB_FILE
REPORT_TYPE

Field Summary

Fields

Modifier and Type	Field and Description
String	description Explanation for the CLI parameter.
boolean	hasArg Boolean indicating whether the parameter has arguments.
String	id Short Id for the CLI parameter.
boolean	mandatory Boolean indicating whether the parameter is mandatory.

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 String	getOptionsAsString() Returns the options as a string.
static String	getOutputOptionsAsString() Returns the output options as a string.
static ReportCLIParams	valueOf(String name) Returns the enum constant of this type with the specified name.
static ReportCLIParams[]	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

PSDB_FILE

public static final ReportCLIParams PSDB_FILE

EXPORT_FOLDER

public static final ReportCLIParams EXPORT_FOLDER

EXPORT_PREFIX

public static final ReportCLIParams EXPORT_PREFIX

REPORT_TYPE

public static final ReportCLIParams REPORT_TYPE

DOCUMENTATION_TYPE

public static final ReportCLIParams DOCUMENTATION_TYPE

GZIP

public static final ReportCLIParams GZIP

Field Detail

id

public final String id

Short Id for the CLI parameter.

description

public final String description

Explanation for the CLI parameter.

mandatory

public final boolean mandatory

Boolean indicating whether the parameter is mandatory.

hasArg

public final boolean hasArg

Boolean indicating whether the parameter has arguments.

Method Detail

values

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

Returns:

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

valueOf

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

getOptionsAsString

public static String getOptionsAsString()

Returns the options as a string.

Returns:

the options as a string

getOutputOptionsAsString

public static String getOutputOptionsAsString()

Returns the output options as a string.

Returns:

the output options as a string