Package eu.isas.searchgui.cmd

Enum FastaCLIParams

java.lang.Object

java.lang.Enum<FastaCLIParams>

eu.isas.searchgui.cmd.FastaCLIParams

All Implemented Interfaces:

Serializable, Comparable<FastaCLIParams>, java.lang.constant.Constable

public enum FastaCLIParams
extends Enum<FastaCLIParams>

This class contains the parameters which can be used in the FASTA command line.

Author:

Marc Vaudel, Harald Barsnes

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
decoy
decoy_suffix
in

Field Summary

Fields

Modifier and Type	Field	Description
String	description	Explanation for the CLI parameter.
boolean	hasArgument	Boolean indicating whether the command option has argument.
String	id	Short Id for the CLI parameter.
boolean	mandatory	Boolean indicating whether the parameter is mandatory.

Method Summary

Modifier and Type	Method	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 FastaCLIParams	valueOf(String name)	Returns the enum constant of this type with the specified name.
static FastaCLIParams[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

in

public static final FastaCLIParams in

decoy

public static final FastaCLIParams decoy

decoy_suffix

public static final FastaCLIParams decoy_suffix

Field Details

id

public String id

Short Id for the CLI parameter.

description

public String description

Explanation for the CLI parameter.

mandatory

public boolean mandatory

Boolean indicating whether the parameter is mandatory.

hasArgument

public boolean hasArgument

Boolean indicating whether the command option has argument.

Method Details

values

public static FastaCLIParams[] values()

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

Returns:

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

valueOf

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

getOptionsAsString

public static String getOptionsAsString()

Returns the options as a string.

Returns:

the options as a string

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