Package eu.isas.peptideshaker.cmd

Enum FollowUpCLIParams

java.lang.Object
java.lang.Enum<FollowUpCLIParams>
eu.isas.peptideshaker.cmd.FollowUpCLIParams
All Implemented Interfaces:
Serializable, Comparable<FollowUpCLIParams>, java.lang.constant.Constable
public enum FollowUpCLIParams extends Enum<FollowUpCLIParams>
Enum class specifying the Command Line Parameters for follow up analysis.
Author:
Marc Vaudel, Harald Barsnes

  • Enum Constant Details

  • 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 final boolean hasArgument
      Indicates whether user input is expected.

  • Method Details

    • values

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