org.biojava.nbio.protmod

Enum ModificationCategory

java.lang.Object

java.lang.Enum<ModificationCategory>

org.biojava.nbio.protmod.ModificationCategory

All Implemented Interfaces:

Serializable, Comparable<ModificationCategory>

public enum ModificationCategory
extends Enum<ModificationCategory>

define modification categories.

Since:

3.0

Author:

Jianjiong Gao

Enum Constant Summary

Enum Constants

Enum Constant and Description
ATTACHMENT
CHEMICAL_MODIFICATION
CROSS_LINK_1
CROSS_LINK_2
CROSS_LINK_3
CROSS_LINK_4
CROSS_LINK_5
CROSS_LINK_6
CROSS_LINK_7
CROSS_LINK_8_OR_LARGE
UNDEFINED

Method Summary

Modifier and Type	Method and Description
String	description()
static ModificationCategory	getByLabel(String label)
boolean	isCrossLink()
String	label()
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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ATTACHMENT

public static final ModificationCategory ATTACHMENT

CHEMICAL_MODIFICATION

public static final ModificationCategory CHEMICAL_MODIFICATION

CROSS_LINK_1

public static final ModificationCategory CROSS_LINK_1

CROSS_LINK_2

public static final ModificationCategory CROSS_LINK_2

CROSS_LINK_3

public static final ModificationCategory CROSS_LINK_3

CROSS_LINK_4

public static final ModificationCategory CROSS_LINK_4

CROSS_LINK_5

public static final ModificationCategory CROSS_LINK_5

CROSS_LINK_6

public static final ModificationCategory CROSS_LINK_6

CROSS_LINK_7

public static final ModificationCategory CROSS_LINK_7

CROSS_LINK_8_OR_LARGE

public static final ModificationCategory CROSS_LINK_8_OR_LARGE

UNDEFINED

public static final ModificationCategory UNDEFINED

Method Detail

values

public static ModificationCategory[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ModificationCategory c : ModificationCategory.values())
    System.out.println(c);

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

label

public String label()

Returns:

the label of this ModificationCategory.

description

public String description()

Returns:

the description

toString

public String toString()

Overrides:

toString in class Enum<ModificationCategory>

Returns:

the label of this ModificationCategory.

isCrossLink

public boolean isCrossLink()

Returns:

true if it is a CrossLink; false, otherwise.

getByLabel

public static ModificationCategory getByLabel(String label)

Parameters:

label - the label of ModificationCategory.

Returns:

the ModificationCategory that has the label.