Package com.compomics.util.parameters.searchgui

Enum OutputParameters

java.lang.Object
java.lang.Enum<OutputParameters>
com.compomics.util.parameters.searchgui.OutputParameters
All Implemented Interfaces:
Serializable, Comparable<OutputParameters>, java.lang.constant.Constable
public enum OutputParameters extends Enum<OutputParameters>
This enum lists the possible output options.
Author:
Marc Vaudel, Harald Barsnes

  • Enum Constant Details

    • grouped

      public static final OutputParameters grouped
      Groups all files in a single compressed zip folder.

    • run

      public static final OutputParameters run
      Groups files per run (i.e. spectrum file).

    • algorithm

      public static final OutputParameters algorithm
      Groups files per identification algorithm.

    • no_zip

      public static final OutputParameters no_zip
      No file grouping.

  • Field Details

    • id

      public final int id
      The index of the option.

    • name

      public final String name
      Name of the option.

    • description

      public final String description
      The description of the option.

  • Method Details

    • values

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

    • getOutputOptions

      public static int[] getOutputOptions()
      Returns an array of the indexes of the different output options.
      Returns:
      an array of the indexes of the different output options

    • getOutputParametersNames

      public static String[] getOutputParametersNames()
      Returns an array of the names of the different options.
      Returns:
      an array of the names of the different options

    • getOutputParameters

      public static OutputParameters getOutputParameters(int id)
      Returns the output option of the given index.
      Parameters:
      id - the index of the output option of interest
      Returns:
      the output option of interest

    • getCommandLineOptions

      public static String getCommandLineOptions()
      Convenience method returning all possibilities in a command line option description format.
      Returns:
      all possibilities in a command line option description format