Package eu.isas.peptideshaker.cmd

Enum StirredOptions

java.lang.Object
java.lang.Enum<StirredOptions>
eu.isas.peptideshaker.cmd.StirredOptions
All Implemented Interfaces:
Serializable, Comparable<StirredOptions>, java.lang.constant.Constable
public enum StirredOptions extends Enum<StirredOptions>
Enum class specifying the ModificationsCLI parameters.
Author:
Marc Vaudel, Harald Barsnes

  • Enum Constant Details

  • Field Details

    • opt

      public final String opt
      Short key for the command line argument.

    • longOpt

      public final String longOpt
      Key for the command line argument.

    • description

      public final String description
      Description for the command line argument.

    • mandatory

      public final boolean mandatory
      If true the parameter is mandatory.

    • hasValue

      public final boolean hasValue
      If true this command line argument needs a value.

  • Method Details

    • values

      public static StirredOptions[] 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 StirredOptions 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