Package eu.isas.peptideshaker.followup

Enum InclusionListExport.PeptideFilterType

java.lang.Object

java.lang.Enum<InclusionListExport.PeptideFilterType>

eu.isas.peptideshaker.followup.InclusionListExport.PeptideFilterType

All Implemented Interfaces:

Serializable, Comparable<InclusionListExport.PeptideFilterType>, java.lang.constant.Constable

Enclosing class:

InclusionListExport

public static enum InclusionListExport.PeptideFilterType
extends Enum<InclusionListExport.PeptideFilterType>

Enum of the peptide filters 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
degenerated	Degenerated Peptides.
miscleaved	Miscleaved Peptides.
reactive	Reactive Peptides.

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 InclusionListExport.PeptideFilterType	getTypeFromIndex(int index)	Returns the parameter type corresponding to a given index.
static InclusionListExport.PeptideFilterType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static InclusionListExport.PeptideFilterType[]	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

miscleaved

public static final InclusionListExport.PeptideFilterType miscleaved

Miscleaved Peptides.

reactive

public static final InclusionListExport.PeptideFilterType reactive

Reactive Peptides.

degenerated

public static final InclusionListExport.PeptideFilterType degenerated

Degenerated Peptides.

Field Details

index

public int index

Index for the export type.

description

public String description

Description of the export.

Method Details

values

public static InclusionListExport.PeptideFilterType[] 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 InclusionListExport.PeptideFilterType 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 InclusionListExport.PeptideFilterType getTypeFromIndex(int index)

Returns the parameter type corresponding to a given index.

Parameters:

index - the index of interest

Returns:

the parameter 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