org.openscience.cdk

Enum ReactionRole

java.lang.Object

java.lang.Enum<ReactionRole>

org.openscience.cdk.ReactionRole

All Implemented Interfaces:

Serializable, Comparable<ReactionRole>

public enum ReactionRole
extends Enum<ReactionRole>

Enum Constant Summary

Enum Constants

Enum Constant and Description
Agent
None
Product
Reactant

Method Summary

Methods

Modifier and Type	Method and Description
static ReactionRole	valueOf(String name) Returns the enum constant of this type with the specified name.
static ReactionRole[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Reactant

public static final ReactionRole Reactant

Agent

public static final ReactionRole Agent

Product

public static final ReactionRole Product

None

public static final ReactionRole None

Method Detail

values

public static ReactionRole[] 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 (ReactionRole c : ReactionRole.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ReactionRole 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