com.compomics.util.experiment.identification.ptm

Enum PtmScore

java.lang.Object

java.lang.Enum<PtmScore>

com.compomics.util.experiment.identification.ptm.PtmScore

All Implemented Interfaces:

Serializable, Comparable<PtmScore>

public enum PtmScore
extends Enum<PtmScore>

An enum of the PTM scores.

Author:

Marc Vaudel

Enum Constant Summary

Enum Constants

Enum Constant and Description
AScore The A score.
PhosphoRS The PhosphoRS score.

Method Summary

Methods

Modifier and Type	Method and Description
static String	getCommandLineOptions() Returns the different implemented scores as list of command line option.
int	getId() Returns the id number of the score.
static ArrayList<PtmScore>	getImplementedPtmScores() Returns a list of the implemented scores.
String	getName() Returns the name of the score.
static PtmScore	getScore(int id) Returns the PTM score indexed by the given id.
static PtmScore	getScore(String name) Returns the PTM score of the given name.
static String[]	getScoreNames() Returns a list containing the names of the implemented scores.
static PtmScore	valueOf(String name) Returns the enum constant of this type with the specified name.
static PtmScore[]	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

AScore

public static final PtmScore AScore

The A score.

PhosphoRS

public static final PtmScore PhosphoRS

The PhosphoRS score.

Method Detail

values

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

Returns:

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

valueOf

public static PtmScore 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

getId

public int getId()

Returns the id number of the score.

Returns:

the id number of the score

getName

public String getName()

Returns the name of the score.

Returns:

the name of the score

getImplementedPtmScores

public static ArrayList<PtmScore> getImplementedPtmScores()

Returns a list of the implemented scores.

Returns:

a list of the implemented scores

getScore

public static PtmScore getScore(int id)

Returns the PTM score indexed by the given id.

Parameters:

id - the id number of the PTM score

Returns:

the desired PTM score

getScore

public static PtmScore getScore(String name)

Returns the PTM score of the given name.

Parameters:

name - the name of the score

Returns:

the desired PTM score

getCommandLineOptions

public static String getCommandLineOptions()

Returns the different implemented scores as list of command line option.

Returns:

the different implemented scores as list of command line option

getScoreNames

public static String[] getScoreNames()

Returns a list containing the names of the implemented scores.

Returns:

a list containing the names of the implemented scores