eu.isas.peptideshaker.followup

Enum FastaExport.ExportType

java.lang.Object

java.lang.Enum<FastaExport.ExportType>

eu.isas.peptideshaker.followup.FastaExport.ExportType

All Implemented Interfaces:

Serializable, Comparable<FastaExport.ExportType>

Enclosing class:

FastaExport

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

Enum of the different types of export implemented.

Enum Constant Summary

Enum Constants

Enum Constant and Description
non_validated Exports accessions which cannot be mapped to a protein group.
validated_all_accessions Exports all accessions of validated protein groups.
validated_main_accession Exports the main accession of validated protein groups.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and 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 FastaExport.ExportType	getTypeFromIndex(int index) Returns the export type corresponding to a given index.
static FastaExport.ExportType	valueOf(String name) Returns the enum constant of this type with the specified name.
static FastaExport.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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

validated_main_accession

public static final FastaExport.ExportType validated_main_accession

Exports the main accession of validated protein groups.

validated_all_accessions

public static final FastaExport.ExportType validated_all_accessions

Exports all accessions of validated protein groups.

non_validated

public static final FastaExport.ExportType non_validated

Exports accessions which cannot be mapped to a protein group.

Field Detail

index

public final int index

Index for the export type.

description

public final String description

Description of the export.

Method Detail

values

public static FastaExport.ExportType[] 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 (FastaExport.ExportType c : FastaExport.ExportType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FastaExport.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 FastaExport.ExportType getTypeFromIndex(int index)

Returns the export type corresponding to a given index.

Parameters:

index - the index of interest

Returns:

the export type

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