Package com.compomics.util.experiment.biology.ions

Enum Ion.IonType

java.lang.Object

java.lang.Enum<Ion.IonType>

com.compomics.util.experiment.biology.ions.Ion.IonType

All Implemented Interfaces:

Serializable, Comparable<Ion.IonType>, java.lang.constant.Constable

Enclosing class:

Ion

public static enum Ion.IonType
extends Enum<Ion.IonType>

An enumerator of the supported ion types.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ELEMENTARY_ION	Identifier for an elementary ion.
GLYCAN	Identifier for a glycan.
IMMONIUM_ION	Identifier for an immonium ion.
PEPTIDE_FRAGMENT_ION	Identifier for a peptide fragment ion.
PRECURSOR_ION	Identifier for an MH ion.
RELATED_ION	Identifier for a related ion.
REPORTER_ION	Identifier for a reporter ion.
TAG_FRAGMENT_ION	A tag fragment ion
UNKNOWN	Identifier for an unknown ion.

Field Summary

Fields

Modifier and Type	Field	Description
final int	index	The index of the type.

Method Summary

Modifier and Type	Method	Description
static Ion.IonType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Ion.IonType[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PEPTIDE_FRAGMENT_ION

public static final Ion.IonType PEPTIDE_FRAGMENT_ION

Identifier for a peptide fragment ion.

TAG_FRAGMENT_ION

public static final Ion.IonType TAG_FRAGMENT_ION

A tag fragment ion

PRECURSOR_ION

public static final Ion.IonType PRECURSOR_ION

Identifier for an MH ion. The number of H is not represented here.

IMMONIUM_ION

public static final Ion.IonType IMMONIUM_ION

Identifier for an immonium ion.

REPORTER_ION

public static final Ion.IonType REPORTER_ION

Identifier for a reporter ion.

GLYCAN

public static final Ion.IonType GLYCAN

Identifier for a glycan.

ELEMENTARY_ION

public static final Ion.IonType ELEMENTARY_ION

Identifier for an elementary ion.

UNKNOWN

public static final Ion.IonType UNKNOWN

Identifier for an unknown ion.

RELATED_ION

public static final Ion.IonType RELATED_ION

Identifier for a related ion.

Field Details

index

public final int index

The index of the type.

Method Details

values

public static Ion.IonType[] 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 Ion.IonType 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