Package eu.isas.peptideshaker.followup

Enum SpectrumExporter.ExportType

java.lang.Object

java.lang.Enum<SpectrumExporter.ExportType>

eu.isas.peptideshaker.followup.SpectrumExporter.ExportType

All Implemented Interfaces:

Serializable, Comparable<SpectrumExporter.ExportType>, java.lang.constant.Constable

Enclosing class:

SpectrumExporter

public static enum SpectrumExporter.ExportType
extends Enum<SpectrumExporter.ExportType>

Enum of the different types of export implemented.

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
non_validated_peptides	Exports the spectra of PSMs of non-validated peptides.
non_validated_proteins	Exports the spectra of PSMs of non-validated proteins.
non_validated_psms	Exports the spectra of non-validated PSMs.
validated_psms	Exports the spectra of validated PSMs.
validated_psms_peptides	Exports the spectra of validated PSMs of validated peptides.
validated_psms_peptides_proteins	Exports the spectra of validated PSMs of validated peptides of validated proteins.

Field Summary

Fields

Modifier and Type	Field	Description
String	description	Description of the export.
int	index	Index for the export type.

Method Summary

Modifier and Type	Method	Description
static String	getCommandLineOptions()	Returns a description of the command line arguments.
static String[]	getPossibilities()	Returns all possibilities descriptions in an array of string.
static SpectrumExporter.ExportType	getTypeFromIndex(int index)	Returns the export type corresponding to a given index.
static SpectrumExporter.ExportType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SpectrumExporter.ExportType[]	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

non_validated_psms

public static final SpectrumExporter.ExportType non_validated_psms

Exports the spectra of non-validated PSMs.

non_validated_peptides

public static final SpectrumExporter.ExportType non_validated_peptides

Exports the spectra of PSMs of non-validated peptides.

non_validated_proteins

public static final SpectrumExporter.ExportType non_validated_proteins

Exports the spectra of PSMs of non-validated proteins.

validated_psms

public static final SpectrumExporter.ExportType validated_psms

Exports the spectra of validated PSMs.

validated_psms_peptides

public static final SpectrumExporter.ExportType validated_psms_peptides

Exports the spectra of validated PSMs of validated peptides.

validated_psms_peptides_proteins

public static final SpectrumExporter.ExportType validated_psms_peptides_proteins

Exports the spectra of validated PSMs of validated peptides of validated proteins.

Field Details

index

public int index

Index for the export type.

description

public String description

Description of the export.

Method Details

values

public static SpectrumExporter.ExportType[] 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 SpectrumExporter.ExportType 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

getTypeFromIndex

public static SpectrumExporter.ExportType getTypeFromIndex(int index)

Returns the export type corresponding to a given index.

Parameters:

index - the index of interest

Returns:

the export type corresponding to a given index

getPossibilities

public static String[] getPossibilities()

Returns all possibilities descriptions in an array of string. Tip: the position in the array corresponds to the type index.

Returns:

all possibilities descriptions in an array of string

getCommandLineOptions

public static String getCommandLineOptions()

Returns a description of the command line arguments.

Returns:

a description of the command line arguments