Enum EnzymesCLIParams

java.lang.Object
java.lang.Enum<EnzymesCLIParams>
com.compomics.cli.enzymes.EnzymesCLIParams
All Implemented Interfaces:
Serializable, Comparable<EnzymesCLIParams>, java.lang.constant.Constable

public enum EnzymesCLIParams
extends Enum<EnzymesCLIParams>
Enum class specifying the EnzymesCLI parameters.
Author:
Marc Vaudel, Harald Barsnes
  • Enum Constant Details

  • Field Details

    • 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.
    • hasArgument

      public final boolean hasArgument
      Boolean indicating whether this command line option needs an argument.
  • Method Details

    • values

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