org.openscience.cdk.interfaces

Enum IReaction.Direction

java.lang.Object

java.lang.Enum<IReaction.Direction>

org.openscience.cdk.interfaces.IReaction.Direction

All Implemented Interfaces:

Serializable, Comparable<IReaction.Direction>

Enclosing interface:

IReaction

public static enum IReaction.Direction
extends Enum<IReaction.Direction>

Permissible reaction directions.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BACKWARD Reaction equilibrium which is (almost) fully on the reactant side.
BIDIRECTIONAL Reaction equilibrium state.
FORWARD Reaction equilibrium which is (almost) fully on the product side.

Method Summary

Methods

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

FORWARD

public static final IReaction.Direction FORWARD

Reaction equilibrium which is (almost) fully on the product side. Often denoted with a forward arrow.

BACKWARD

public static final IReaction.Direction BACKWARD

Reaction equilibrium which is (almost) fully on the reactant side. Often denoted with a backward arrow.

BIDIRECTIONAL

public static final IReaction.Direction BIDIRECTIONAL

Reaction equilibrium state. Often denoted by a double arrow.

Method Detail

values

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

Returns:

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

valueOf

public static IReaction.Direction 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