Package com.compomics.util.io.export

Enum ExportFormat

java.lang.Object
java.lang.Enum<ExportFormat>
com.compomics.util.io.export.ExportFormat
All Implemented Interfaces:
Serializable, Comparable<ExportFormat>, java.lang.constant.Constable
public enum ExportFormat extends Enum<ExportFormat>
Enum of the different formats available for the exports.
Author:
Marc Vaudel

  • Enum Constant Details

  • Field Details

    • index

      public final int index
      The index of the format.

    • name

      public final String name
      The name of the format.

    • extension

      public final String extension
      The extension to use for this format.

    • description

      public final String description
      Description of the format.

    • commandLineDefaultOption

      public static final ExportFormat commandLineDefaultOption
      The default export format to use for command line exports.

    • guiDefaultOption

      public static final ExportFormat guiDefaultOption
      The default export format to use for GUI exports.

  • Method Details

    • values

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

    • getCommandLineOption

      public static String getCommandLineOption()
      Returns the command line description when the format is used as command line argument.
      Returns:
      the command line description when the format is used as command line argument

    • getFormatFromCommandLineOption

      public static ExportFormat getFormatFromCommandLineOption(String commandLineOption)
      Returns the export format designed by the given command line option. Null if not found.
      Parameters:
      commandLineOption - the command line option
      Returns:
      the export format designed by the given command line option