org.openscience.cdk.geometry

Enum GeometryUtil.CoordinateCoverage

java.lang.Object

java.lang.Enum<GeometryUtil.CoordinateCoverage>

org.openscience.cdk.geometry.GeometryUtil.CoordinateCoverage

All Implemented Interfaces:

Serializable, Comparable<GeometryUtil.CoordinateCoverage>

Enclosing class:

GeometryUtil

public static enum GeometryUtil.CoordinateCoverage
extends Enum<GeometryUtil.CoordinateCoverage>

Provides the coverage of coordinates for this molecule.

See Also:

GeometryUtil.get2DCoordinateCoverage(org.openscience.cdk.interfaces.IAtomContainer), GeometryUtil.get3DCoordinateCoverage(org.openscience.cdk.interfaces.IAtomContainer)

Enum Constant Summary

Enum Constants

Enum Constant and Description
FULL All atoms have coordinates.
NONE No atoms have coordinates.
PARTIAL At least one atom has coordinates but not all.

Method Summary

Methods

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

FULL

public static final GeometryUtil.CoordinateCoverage FULL

All atoms have coordinates.

PARTIAL

public static final GeometryUtil.CoordinateCoverage PARTIAL

At least one atom has coordinates but not all.

NONE

public static final GeometryUtil.CoordinateCoverage NONE

No atoms have coordinates.

Method Detail

values

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

Returns:

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

valueOf

public static GeometryUtil.CoordinateCoverage 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