Package com.compomics.util.parameters.identification.search

Enum DigestionParameters.Specificity

java.lang.Object

java.lang.Enum<DigestionParameters.Specificity>

com.compomics.util.parameters.identification.search.DigestionParameters.Specificity

All Implemented Interfaces:

Serializable, Comparable<DigestionParameters.Specificity>, java.lang.constant.Constable

Enclosing class:

DigestionParameters

public static enum DigestionParameters.Specificity
extends Enum<DigestionParameters.Specificity>

Enum for the different types of enzyme specificity.

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
semiSpecific	Specific at only one of the termini.
specific	Specific at both termini.
specificCTermOnly	Specific at the C-terminus only.
specificNTermOnly	Specific at the N-terminus only.

Field Summary

Fields

Modifier and Type	Field	Description
final int	index	The index.
final String	name	The name.

Method Summary

Modifier and Type	Method	Description
static String	getCommandLineDescription()	Returns the different options as command line description.
static DigestionParameters.Specificity	getSpecificity(int index)	Returns the specificity of the given index.
String	toString()
static DigestionParameters.Specificity	valueOf(String name)	Returns the enum constant of this type with the specified name.
static DigestionParameters.Specificity[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

specific

public static final DigestionParameters.Specificity specific

Specific at both termini.

semiSpecific

public static final DigestionParameters.Specificity semiSpecific

Specific at only one of the termini.

specificNTermOnly

public static final DigestionParameters.Specificity specificNTermOnly

Specific at the N-terminus only.

specificCTermOnly

public static final DigestionParameters.Specificity specificCTermOnly

Specific at the C-terminus only.

Field Details

index

public final int index

The index.

name

public final String name

The name.

Method Details

values

public static DigestionParameters.Specificity[] 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 DigestionParameters.Specificity 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

getSpecificity

public static DigestionParameters.Specificity getSpecificity(int index)

Returns the specificity of the given index.

Parameters:

index - the index of the specificity

Returns:

the corresponding specificity

getCommandLineDescription

public static String getCommandLineDescription()

Returns the different options as command line description.

Returns:

the different options as command line description

toString

public String toString()

Overrides:

toString in class Enum<DigestionParameters.Specificity>