Package eu.isas.reporter.settings

Enum ReporterIonsLocationType

java.lang.Object

java.lang.Enum<ReporterIonsLocationType>

eu.isas.reporter.settings.ReporterIonsLocationType

All Implemented Interfaces:

Serializable, Comparable<ReporterIonsLocationType>, java.lang.constant.Constable

public enum ReporterIonsLocationType
extends Enum<ReporterIonsLocationType>

Enum of the possible spectrum reporter ions locations.

Author:

Harald Barsnes

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
ms2Spectra	The reporter ions are in the same MS2 spectrum.
ms3Spectra	The reporter ions are in the related MS3 spectrum.
precursorMatching	The reporter ions are found by matching on mass and retention time.

Field Summary

Fields

Modifier and Type	Field	Description
final int	index	The index of the reporter ions location type.
final String	name	The name of the reporter ions location type.

Method Summary

Modifier and Type	Method	Description
static String	getCommandLineDescription()	Returns the different options as command line description.
static ReporterIonsLocationType	getReporterIonsLocationType(int index)	Returns the reporter ions location type corresponding to the given index.
static ReporterIonsLocationType	getReporterIonsLocationType(String name)	Returns the reporter ions location type corresponding to the given name.
static ReporterIonsLocationType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ReporterIonsLocationType[]	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

ms2Spectra

public static final ReporterIonsLocationType ms2Spectra

The reporter ions are in the same MS2 spectrum.

ms3Spectra

public static final ReporterIonsLocationType ms3Spectra

The reporter ions are in the related MS3 spectrum.

precursorMatching

public static final ReporterIonsLocationType precursorMatching

The reporter ions are found by matching on mass and retention time.

Field Details

index

public final int index

The index of the reporter ions location type.

name

public final String name

The name of the reporter ions location type.

Method Details

values

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

getReporterIonsLocationType

public static ReporterIonsLocationType getReporterIonsLocationType(int index)

Returns the reporter ions location type corresponding to the given index.

Parameters:

index - the index of the reporter ions location type

Returns:

the reporter ions location type of interest.

getReporterIonsLocationType

public static ReporterIonsLocationType getReporterIonsLocationType(String name)

Returns the reporter ions location type corresponding to the given name.

Parameters:

name - the name of the reporter ions location type

Returns:

the reporter ions location type of interest.

getCommandLineDescription

public static String getCommandLineDescription()

Returns the different options as command line description.

Returns:

the different options as command line description