Enum IonMatch.MzErrorType

java.lang.Object
java.lang.Enum<IonMatch.MzErrorType>
com.compomics.util.experiment.identification.matches.IonMatch.MzErrorType
All Implemented Interfaces:
Serializable, Comparable<IonMatch.MzErrorType>, java.lang.constant.Constable
Enclosing class:
IonMatch

public static enum IonMatch.MzErrorType
extends Enum<IonMatch.MzErrorType>
Enum of the supported error types.
  • Enum Constant Details

  • Field Details

    • name

      public final String name
      The name of the error type.
    • description

      public final String description
      The description of the error type.
    • unit

      public final String unit
      The unit to use
  • Method Details

    • values

      public static IonMatch.MzErrorType[] 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 IonMatch.MzErrorType 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
    • getMzErrorType

      public static IonMatch.MzErrorType getMzErrorType​(int index)
      Returns the error type corresponding to the given index. Error types are indexed according to the values() method. Null if not found.
      Parameters:
      index - the index of the error type in the values() method
      Returns:
      the corresponding error type