Package com.compomics.util.parameters.peptide_shaker

Enum ProjectType

java.lang.Object

java.lang.Enum<ProjectType>

com.compomics.util.parameters.peptide_shaker.ProjectType

All Implemented Interfaces:

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

public enum ProjectType
extends Enum<ProjectType>

This enum lists the different types of projects that can be created using PeptideShaker.

Author:

Marc Vaudel

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
peptide
protein
psm

Field Summary

Fields

Modifier and Type	Field	Description
final String	description	The description of the option.
final int	index	The index of the option.
final String	name	The name of the option.

Method Summary

Modifier and Type	Method	Description
static String	getCommandLineOptions()	Returns a description of the command line arguments.
static String[]	getGuiOptions()	Returns the different options as they should be displayed on the GUI.
static ProjectType	getProjectType(int index)	Returns the project type corresponding to the given index.
static ProjectType	getProjectType(String guiOption)	Returns the project type corresponding to the given GUI option.
static ProjectType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ProjectType[]	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

psm

public static final ProjectType psm

peptide

public static final ProjectType peptide

protein

public static final ProjectType protein

Field Details

index

public final int index

The index of the option.

name

public final String name

The name of the option.

description

public final String description

The description of the option.

Method Details

values

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

getGuiOptions

public static String[] getGuiOptions()

Returns the different options as they should be displayed on the GUI.

Returns:

the different options as they should be displayed on the GUI

getProjectType

public static ProjectType getProjectType(String guiOption)

Returns the project type corresponding to the given GUI option.

Parameters:

guiOption - the GUI option

Returns:

the project type

getProjectType

public static ProjectType getProjectType(int index)

Returns the project type corresponding to the given index.

Parameters:

index - the index

Returns:

the project type

getCommandLineOptions

public static String getCommandLineOptions()

Returns a description of the command line arguments.

Returns:

a description of the command line arguments