com.compomics.util.experiment.identification.matches

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>

Enclosing class:

IonMatch

public static enum IonMatch.MzErrorType
extends Enum<IonMatch.MzErrorType>

Enum of the supported error types.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Absolute
RelativePpm
Statistical

Field Summary

Fields

Modifier and Type	Field and Description
String	description The description of the error type.
String	name The name of the error type.
String	unit The unit to use

Method Summary

Modifier and Type	Method and Description
static IonMatch.MzErrorType	getMzErrorType(int index) Returns the error type corresponding to the given index.
static IonMatch.MzErrorType	valueOf(String name) Returns the enum constant of this type with the specified name.
static IonMatch.MzErrorType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Absolute

public static final IonMatch.MzErrorType Absolute

RelativePpm

public static final IonMatch.MzErrorType RelativePpm

Statistical

public static final IonMatch.MzErrorType Statistical

Field Detail

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 Detail

values

public static IonMatch.MzErrorType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (IonMatch.MzErrorType c : IonMatch.MzErrorType.values())
    System.out.println(c);

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