org.openscience.cdk.interfaces

Enum IBond.Order

java.lang.Object

java.lang.Enum<IBond.Order>

org.openscience.cdk.interfaces.IBond.Order

All Implemented Interfaces:

Serializable, Comparable<IBond.Order>

Enclosing interface:

IBond

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

A list of permissible bond orders.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DOUBLE
QUADRUPLE
QUINTUPLE
SEXTUPLE
SINGLE
TRIPLE
UNSET

Method Summary

Modifier and Type	Method and Description
Integer	numeric() Access a numeric value for the number of bonded electron pairs.
static IBond.Order	valueOf(String name) Returns the enum constant of this type with the specified name.
static IBond.Order[]	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

SINGLE

public static final IBond.Order SINGLE

DOUBLE

public static final IBond.Order DOUBLE

TRIPLE

public static final IBond.Order TRIPLE

QUADRUPLE

public static final IBond.Order QUADRUPLE

QUINTUPLE

public static final IBond.Order QUINTUPLE

SEXTUPLE

public static final IBond.Order SEXTUPLE

UNSET

public static final IBond.Order UNSET

Method Detail

values

public static IBond.Order[] 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.Order c : IBond.Order.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.Order 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

numeric

public Integer numeric()

Access a numeric value for the number of bonded electron pairs.

 Order.SINGLE.numeric()    // 1
 Order.DOUBLE.numeric()    // 2
 Order.TRIPLE.numeric()    // 3
 Order.QUADRUPLE.numeric() // 4
 Order.QUINTUPLE.numeric() // 5
 Order.SEXTUPLE.numeric()  // 6
 Order.UNSET.numeric()     // 0
 

Returns:

number of bonded electron pairs