Package com.compomics.cli.modifications
Enum ModificationsCLIParams
- All Implemented Interfaces:
Serializable
,Comparable<ModificationsCLIParams>
,java.lang.constant.Constable
public enum ModificationsCLIParams extends Enum<ModificationsCLIParams>
Enum class specifying the ModificationsCLI parameters.
- Author:
- Marc Vaudel, Harald Barsnes
-
Nested Class Summary
-
Enum Constant Summary
Enum Constants Enum Constant Description CATEGORY
COMPOSITION_ADDED
COMPOSITION_REMOVED
IN
LIST
NAME
OUT
PATTERN
PATTERN_INDEX
RM
SHORT_NAME
TYPE
-
Field Summary
Fields Modifier and Type Field Description String
description
Explanation for the CLI parameter.boolean
hasArgument
Boolean indicating whether this command line option needs an 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 ModificationsCLIParams
valueOf(String name)
Returns the enum constant of this type with the specified name.static ModificationsCLIParams[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
Field Details
-
id
Short Id for the CLI parameter. -
description
Explanation for the CLI parameter. -
mandatory
public final boolean mandatoryBoolean indicating whether the parameter is mandatory. -
hasArgument
public final boolean hasArgumentBoolean indicating whether this command line option needs an argument.
-
-
Method Details
-
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
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 nameNullPointerException
- 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
Returns the options as a string.- Returns:
- the options as a string
-