Package com.compomics.util.experiment.mass_spectrometry.proteowizard

Enum ProteoWizardMsFormat

java.lang.Object
java.lang.Enum<ProteoWizardMsFormat>
com.compomics.util.experiment.mass_spectrometry.proteowizard.ProteoWizardMsFormat
All Implemented Interfaces:
Serializable, Comparable<ProteoWizardMsFormat>, java.lang.constant.Constable
public enum ProteoWizardMsFormat extends Enum<ProteoWizardMsFormat>
The mass spectrometry formats supported by ProteoWizard.
Author:
Marc Vaudel, Harald Barsnes

  • Enum Constant Details

  • Field Details

    • index

      public final int index
      The index of the format.

    • commandLineOption

      public final String commandLineOption
      The command line option name.

    • name

      public final String name
      The name of the format.

    • description

      public final String description
      A brief description of the format.

    • rawFormat

      public final boolean rawFormat
      Boolean indicating if this in a format for raw data, false means that it is a peak list format.

    • fileNameEnding

      public final String fileNameEnding
      The file name ending of the format.

    • outputFormat

      public final boolean outputFormat
      Boolean indicating if this in a format that can be used as output.

  • Method Details

    • values

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

    • toString

      public String toString()
      Overrides:
      toString in class Enum<ProteoWizardMsFormat>

    • getDataFormats

      public static ProteoWizardMsFormat[] getDataFormats(Boolean raw, Boolean outputFormat)
      Returns a list of formats.
      Parameters:
      raw - get raw formats, null returns both
      outputFormat - get output formats, null return both
      Returns:
      the list formats