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

Enum ModificationCategory

java.lang.Object

java.lang.Enum<ModificationCategory>

com.compomics.util.experiment.biology.modifications.ModificationCategory

All Implemented Interfaces:

Serializable, Comparable<ModificationCategory>, java.lang.constant.Constable

public enum ModificationCategory
extends Enum<ModificationCategory>

Enum for the different modification categories supported.

Author:

Harald Barsnes

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
Common	Common fixed and variable modifications.
Common_Artifact	Common chemical artifacts.
Common_Biological	Common biological modifications.
Glyco	Glycosylation.
Labeling	Modifications as part of labeling.
Less_Common	Less common modifications.
Metal	Modifications including metals.
Nucleotide_Substitution_One	Nucleotide substitutions that can be done by changing one nucleotide.
Nucleotide_Substitution_TwoPlus	Nucleotide substitutions that require changing two or more nucleotide.
Other	Modifications not fitting in any of the other categories.

Method Summary

Modifier and Type	Method	Description
static String	getCategoriesAsString()	Returns all of the modification category options as a string.
String	toString()
static ModificationCategory	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ModificationCategory[]	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

Common

public static final ModificationCategory Common

Common fixed and variable modifications.

Common_Biological

public static final ModificationCategory Common_Biological

Common biological modifications.

Common_Artifact

public static final ModificationCategory Common_Artifact

Common chemical artifacts.

Metal

public static final ModificationCategory Metal

Modifications including metals.

Glyco

public static final ModificationCategory Glyco

Glycosylation.

Less_Common

public static final ModificationCategory Less_Common

Less common modifications.

Labeling

public static final ModificationCategory Labeling

Modifications as part of labeling.

Nucleotide_Substitution_One

public static final ModificationCategory Nucleotide_Substitution_One

Nucleotide substitutions that can be done by changing one nucleotide.

Nucleotide_Substitution_TwoPlus

public static final ModificationCategory Nucleotide_Substitution_TwoPlus

Nucleotide substitutions that require changing two or more nucleotide.

Other

public static final ModificationCategory Other

Modifications not fitting in any of the other categories.

Method Details

values

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

getCategoriesAsString

public static String getCategoriesAsString()

Returns all of the modification category options as a string.

Returns:

the modification category options