Package com.compomics.util.experiment.biology.modifications

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

  • Enum Constant Details

    • modaa

      public static final ModificationType modaa
      Modification at specific amino acids.

    • modn_protein

      public static final ModificationType modn_protein
      Modification at the N-terminus of a protein.

    • modnaa_protein

      public static final ModificationType modnaa_protein
      Modification at the N-terminus of a protein at specific amino acids.

    • modc_protein

      public static final ModificationType modc_protein
      Modification at the C-terminus of a protein.

    • modcaa_protein

      public static final ModificationType modcaa_protein
      Modification at the C-terminus of a protein at specific amino acids.

    • modn_peptide

      public static final ModificationType modn_peptide
      Modification at the N-terminus of a peptide.

    • modnaa_peptide

      public static final ModificationType modnaa_peptide
      Modification at the N-terminus of a peptide at specific amino acids.

    • modc_peptide

      public static final ModificationType modc_peptide
      Modification at the C-terminus of a peptide.

    • modcaa_peptide

      public static final ModificationType modcaa_peptide
      Modification at the C-terminus of a peptide at specific amino acids.

  • Field Details

    • index

      public final int index
      The index of the type, must be the index in the values array.

    • description

      public final String description
      The description of the type.

    • shortName

      public final String shortName
      The short name of the type.

  • Method Details

    • values

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

    • 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

      public String toString()
      Overrides:
      toString in class Enum<ModificationType>

    • getTypesAsString

      public static String getTypesAsString()
      Returns all of the modification type options as a string.
      Returns:
      the modification type options