org.openscience.cdk.interfaces

Enum IBond.Stereo

java.lang.Object

java.lang.Enum<IBond.Stereo>

org.openscience.cdk.interfaces.IBond.Stereo

All Implemented Interfaces:

Serializable, Comparable<IBond.Stereo>

Enclosing interface:

IBond

public static enum IBond.Stereo
extends Enum<IBond.Stereo>

Enumeration of possible stereo types of two-atom bonds. The Stereo type defines not just define the stereochemistry, but also the which atom is the stereo center for which the Stereo is defined. The first atom in the IBond (index = 0) is the start atom, while the second atom (index = 1) is the end atom.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DOWN A bond pointing down of which the start atom is the stereocenter and the end atom is below the drawing plane.
DOWN_INVERTED A bond pointing down of which the end atom is the stereocenter and the start atom is below the drawing plane.
E Indication that this double bond has a E configuration.
E_OR_Z Indication that this double bond has a fixed, but unknown E/Z configuration.
E_Z_BY_COORDINATES Indication that this double bond has a fixed configuration, defined by the 2D and/or 3D coordinates.
NONE A bond for which there is no stereochemistry.
UP A bond pointing up of which the start atom is the stereocenter and the end atom is above the drawing plane.
UP_INVERTED A bond pointing up of which the end atom is the stereocenter and the start atom is above the drawing plane.
UP_OR_DOWN A bond for which there is stereochemistry, we just do not know if it is UP or DOWN.
UP_OR_DOWN_INVERTED A bond for which there is stereochemistry, we just do not know if it is UP or DOWN.
Z Indication that this double bond has a Z configuration.

Method Summary

Methods

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

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final IBond.Stereo NONE

A bond for which there is no stereochemistry.

UP

public static final IBond.Stereo UP

A bond pointing up of which the start atom is the stereocenter and the end atom is above the drawing plane.

UP_INVERTED

public static final IBond.Stereo UP_INVERTED

A bond pointing up of which the end atom is the stereocenter and the start atom is above the drawing plane.

DOWN

public static final IBond.Stereo DOWN

A bond pointing down of which the start atom is the stereocenter and the end atom is below the drawing plane.

DOWN_INVERTED

public static final IBond.Stereo DOWN_INVERTED

A bond pointing down of which the end atom is the stereocenter and the start atom is below the drawing plane.

UP_OR_DOWN

public static final IBond.Stereo UP_OR_DOWN

A bond for which there is stereochemistry, we just do not know if it is UP or DOWN. The start atom is the stereocenter.

UP_OR_DOWN_INVERTED

public static final IBond.Stereo UP_OR_DOWN_INVERTED

A bond for which there is stereochemistry, we just do not know if it is UP or DOWN. The end atom is the stereocenter.

E_OR_Z

public static final IBond.Stereo E_OR_Z

Indication that this double bond has a fixed, but unknown E/Z configuration.

E

public static final IBond.Stereo E

Indication that this double bond has a E configuration.

Z

public static final IBond.Stereo Z

Indication that this double bond has a Z configuration.

E_Z_BY_COORDINATES

public static final IBond.Stereo E_Z_BY_COORDINATES

Indication that this double bond has a fixed configuration, defined by the 2D and/or 3D coordinates.

Method Detail

values

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

Returns:

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

valueOf

public static IBond.Stereo 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