Package org.openscience.cdk.interfaces

Enum Class IReaction.Direction

java.lang.Object

java.lang.Enum<IReaction.Direction>

org.openscience.cdk.interfaces.IReaction.Direction

All Implemented Interfaces:

Serializable, Comparable<IReaction.Direction>, Constable

Enclosing interface:

IReaction

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

Permissible reaction directions.

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
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.
NO_GO	Reaction is a no-go, Often denoted by a cross or hash arrow.
RESONANCE	Reaction shows interconversion between resonance forms.
RETRO_SYNTHETIC	Indicate the precursors for a given molecule, note this will make swap where reactant/products appear.
UNDIRECTED	Reaction equilibrium is not known to be fully on reactant/product or in equilibrium state.

Method Summary

Modifier and Type	Method	Description
static IReaction.Direction	valueOf(String name)	Returns the enum constant of this class with the specified name.
static IReaction.Direction[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

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 stacked arrows, one forwards, one backwards.

NO_GO

public static final IReaction.Direction NO_GO

Reaction is a no-go, Often denoted by a cross or hash arrow.

RETRO_SYNTHETIC

public static final IReaction.Direction RETRO_SYNTHETIC

Indicate the precursors for a given molecule, note this will make swap where reactant/products appear. Usually denoted with an open arrow.

RESONANCE

public static final IReaction.Direction RESONANCE

Reaction shows interconversion between resonance forms. Usually denoted by a double-headed arrow.

UNDIRECTED

public static final IReaction.Direction UNDIRECTED

Reaction equilibrium is not known to be fully on reactant/product or in equilibrium state. Also used to represent a "net reaction" composed of several elementary steps. Often denoted by a "=" sign

Method Details

values

public static IReaction.Direction[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static IReaction.Direction valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null