Package com.compomics.util.experiment.identification.spectrum_annotation.spectrum_annotators

Enum SimplePeptideAnnotator.IonSeries

java.lang.Object

java.lang.Enum<SimplePeptideAnnotator.IonSeries>

com.compomics.util.experiment.identification.spectrum_annotation.spectrum_annotators.SimplePeptideAnnotator.IonSeries

All Implemented Interfaces:

Serializable, Comparable<SimplePeptideAnnotator.IonSeries>, java.lang.constant.Constable

Enclosing class:

SimplePeptideAnnotator

public static enum SimplePeptideAnnotator.IonSeries
extends Enum<SimplePeptideAnnotator.IonSeries>

The type of ion series to annotate.

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
ax
by
cz

Field Summary

Fields

Modifier and Type	Field	Description
final int	complementarySeries	The complementary ion index as listed in the PeptideFragmentIon class.
final int	forwardSeries	The forward ion index as listed in the PeptideFragmentIon class.

Method Summary

Modifier and Type	Method	Description
static SimplePeptideAnnotator.IonSeries	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SimplePeptideAnnotator.IonSeries[]	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

ax

public static final SimplePeptideAnnotator.IonSeries ax

by

public static final SimplePeptideAnnotator.IonSeries by

cz

public static final SimplePeptideAnnotator.IonSeries cz

Field Details

forwardSeries

public final int forwardSeries

The forward ion index as listed in the PeptideFragmentIon class.

complementarySeries

public final int complementarySeries

The complementary ion index as listed in the PeptideFragmentIon class.

Method Details

values

public static SimplePeptideAnnotator.IonSeries[] 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 SimplePeptideAnnotator.IonSeries 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