org.openscience.cdk.io

Enum MDLV2000Writer.SPIN_MULTIPLICITY

java.lang.Object

java.lang.Enum<MDLV2000Writer.SPIN_MULTIPLICITY>

org.openscience.cdk.io.MDLV2000Writer.SPIN_MULTIPLICITY

All Implemented Interfaces:

Serializable, Comparable<MDLV2000Writer.SPIN_MULTIPLICITY>

Enclosing class:

MDLV2000Writer

public static enum MDLV2000Writer.SPIN_MULTIPLICITY
extends Enum<MDLV2000Writer.SPIN_MULTIPLICITY>

Enumeration of all valid radical values.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DivalentSinglet
DivalentTriplet
Monovalent
None

Method Summary

Modifier and Type	Method and Description
int	getSingleElectrons() The number of single electrons that correspond to the spin multiplicity.
int	getValue() Radical value for the spin multiplicity in the properties block.
static MDLV2000Writer.SPIN_MULTIPLICITY	ofValue(int value) Create a SPIN_MULTIPLICITY instance for the specified value.
static MDLV2000Writer.SPIN_MULTIPLICITY	valueOf(String name) Returns the enum constant of this type with the specified name.
static MDLV2000Writer.SPIN_MULTIPLICITY[]	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

None

public static final MDLV2000Writer.SPIN_MULTIPLICITY None

Monovalent

public static final MDLV2000Writer.SPIN_MULTIPLICITY Monovalent

DivalentSinglet

public static final MDLV2000Writer.SPIN_MULTIPLICITY DivalentSinglet

DivalentTriplet

public static final MDLV2000Writer.SPIN_MULTIPLICITY DivalentTriplet

Method Detail

values

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

Returns:

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

valueOf

public static MDLV2000Writer.SPIN_MULTIPLICITY 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

getValue

public int getValue()

Radical value for the spin multiplicity in the properties block.

Returns:

the radical value

getSingleElectrons

public int getSingleElectrons()

The number of single electrons that correspond to the spin multiplicity.

Returns:

the number of single electrons

ofValue

public static MDLV2000Writer.SPIN_MULTIPLICITY ofValue(int value)
                                                throws CDKException

Create a SPIN_MULTIPLICITY instance for the specified value.

Parameters:

value - input value (in the property block)

Returns:

instance

Throws:

CDKException - unknown spin multiplicity value