Enum ModificationType
java.lang.Object
java.lang.Enum<ModificationType>
com.compomics.util.experiment.biology.modifications.ModificationType
- All Implemented Interfaces:
Serializable
,Comparable<ModificationType>
,java.lang.constant.Constable
public enum ModificationType extends Enum<ModificationType>
Enum for the different types of modifications supported.
- Author:
- Marc Vaudel, Harald Barsnes
-
Nested Class Summary
-
Enum Constant Summary
Enum Constants Enum Constant Description modaa
Modification at particular amino acids.modc_peptide
Modification at the C-terminus of a peptide.modc_protein
Modification at the C-terminus of a protein.modcaa_peptide
Modification at the C-terminus of a peptide at particular amino acids.modcaa_protein
Modification at the C-terminus of a protein at particular amino acids.modn_peptide
Modification at the N-terminus of a peptide.modn_protein
Modification at the N-terminus of a protein.modnaa_peptide
Modification at the N-terminus of a peptide at particular amino acids.modnaa_protein
Modification at the N-terminus of a protein at particular amino acids. -
Field Summary
Fields Modifier and Type Field Description String
description
The description of the type.int
index
The index of the type, must be the index in the values array.String
shortName
The short name of the type. -
Method Summary
Modifier and Type Method Description static String
getTypesAsString()
Returns all of the modification type options as a string.boolean
isCTerm()
Returns a boolean indicating whether the modification type targets the C-terminus of a protein or of a peptide.boolean
isNTerm()
Returns a boolean indicating whether the modification type targets the N-terminus of a protein or of a peptide.String
toString()
static ModificationType
valueOf(String name)
Returns the enum constant of this type with the specified name.static ModificationType[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
modaa
Modification at particular amino acids. -
modn_protein
Modification at the N-terminus of a protein. -
modnaa_protein
Modification at the N-terminus of a protein at particular amino acids. -
modc_protein
Modification at the C-terminus of a protein. -
modcaa_protein
Modification at the C-terminus of a protein at particular amino acids. -
modn_peptide
Modification at the N-terminus of a peptide. -
modnaa_peptide
Modification at the N-terminus of a peptide at particular amino acids. -
modc_peptide
Modification at the C-terminus of a peptide. -
modcaa_peptide
Modification at the C-terminus of a peptide at particular amino acids.
-
-
Field Details
-
index
public final int indexThe index of the type, must be the index in the values array. -
description
The description of the type. -
shortName
The short name of the type.
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
isNTerm
public boolean isNTerm()Returns a boolean indicating whether the modification type targets the N-terminus of a protein or of a peptide.- Returns:
- a boolean indicating whether the modification type targets the N-terminus of a protein or of a peptide
-
isCTerm
public boolean isCTerm()Returns a boolean indicating whether the modification type targets the C-terminus of a protein or of a peptide.- Returns:
- a boolean indicating whether the modification type targets the C-terminus of a protein or of a peptide
-
toString
- Overrides:
toString
in classEnum<ModificationType>
-
getTypesAsString
Returns all of the modification type options as a string.- Returns:
- the modification type options
-