Package org.openscience.cdk.fragment

Enum Class ExhaustiveFragmenter.Saturation

java.lang.Object

java.lang.Enum<ExhaustiveFragmenter.Saturation>

org.openscience.cdk.fragment.ExhaustiveFragmenter.Saturation

All Implemented Interfaces:

Serializable, Comparable<ExhaustiveFragmenter.Saturation>, Constable

Enclosing class:

ExhaustiveFragmenter

public static enum ExhaustiveFragmenter.Saturation
extends Enum<ExhaustiveFragmenter.Saturation>

Specifies whether generated fragments should be saturated (hydrogens added) or unsaturated.

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
HYDROGEN_SATURATED_FRAGMENTS	Fragments will be returned in their saturated form (implicit hydrogen atoms added).
R_SATURATED_FRAGMENTS	Fragments will be saturated with R atoms.
UNSATURATED_FRAGMENTS	Fragments will be returned in their unsaturated form (no additional hydrogen atoms).

Method Summary

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

HYDROGEN_SATURATED_FRAGMENTS

public static final ExhaustiveFragmenter.Saturation HYDROGEN_SATURATED_FRAGMENTS

Fragments will be returned in their saturated form (implicit hydrogen atoms added).

R_SATURATED_FRAGMENTS

public static final ExhaustiveFragmenter.Saturation R_SATURATED_FRAGMENTS

Fragments will be saturated with R atoms.

UNSATURATED_FRAGMENTS

public static final ExhaustiveFragmenter.Saturation UNSATURATED_FRAGMENTS

Fragments will be returned in their unsaturated form (no additional hydrogen atoms). The unsaturated atoms are the atoms of the split bonds.

Method Details

values

public static ExhaustiveFragmenter.Saturation[] 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 ExhaustiveFragmenter.Saturation 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