Package com.compomics.util.parameters.identification.advanced

Enum SequenceMatchingParameters.MatchingType

java.lang.Object

java.lang.Enum<SequenceMatchingParameters.MatchingType>

com.compomics.util.parameters.identification.advanced.SequenceMatchingParameters.MatchingType

All Implemented Interfaces:

Serializable, Comparable<SequenceMatchingParameters.MatchingType>, java.lang.constant.Constable

Enclosing class:

SequenceMatchingParameters

public static enum SequenceMatchingParameters.MatchingType
extends Enum<SequenceMatchingParameters.MatchingType>

The different types of amino acid matching.

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
aminoAcid	Matches amino acids.
indistiguishableAminoAcids	Matches amino acids of indistinguishable masses (I/L).
string	Matches character strings only.

Field Summary

Fields

Modifier and Type	Field	Description
final String	description	The description.
final int	index	The index of the type as integer.

Method Summary

Modifier and Type	Method	Description
static String	getCommandLineOptions()	Returns the different matching types as command line options description.
static SequenceMatchingParameters.MatchingType	getMatchingType(int index)	Returns the matching type corresponding to the given index.
String	toString()
static SequenceMatchingParameters.MatchingType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SequenceMatchingParameters.MatchingType[]	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

string

public static final SequenceMatchingParameters.MatchingType string

Matches character strings only.

aminoAcid

public static final SequenceMatchingParameters.MatchingType aminoAcid

Matches amino acids.

indistiguishableAminoAcids

public static final SequenceMatchingParameters.MatchingType indistiguishableAminoAcids

Matches amino acids of indistinguishable masses (I/L).

Field Details

index

public final int index

The index of the type as integer.

description

public final String description

The description.

Method Details

values

public static SequenceMatchingParameters.MatchingType[] 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 SequenceMatchingParameters.MatchingType 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

toString

public String toString()

Overrides:

toString in class Enum<SequenceMatchingParameters.MatchingType>

getCommandLineOptions

public static String getCommandLineOptions()

Returns the different matching types as command line options description.

Returns:

the different matching types as command line options description

getMatchingType

public static SequenceMatchingParameters.MatchingType getMatchingType(int index)

Returns the matching type corresponding to the given index.

Parameters:

index - the index of the matching type

Returns:

the matching type