Package org.openscience.cdk.interfaces

Enum IBond.Display

java.lang.Object

java.lang.Enum<IBond.Display>

org.openscience.cdk.interfaces.IBond.Display

All Implemented Interfaces:

Serializable, Comparable<IBond.Display>

Enclosing interface:

IBond

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

Bond display style, controlling how bonds appear in a 2D depiction.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ArrowBeg	Display as an arrow (e.g.
ArrowEnd	Display as an arrow (e.g.
Bold	A bold line.
Dash	A dashed line.
Dot	A dotted line.
Hash	A hashed line (bold dashed).
Solid	A solid line (default).
Wavy	A wavy line.
WedgeBegin	Display as a bold wedge, with the narrow end towards the begin atom of the bond (IBond.getBegin()).
WedgedHashBegin	Display as a hashed wedge, with the narrow end towards the begin atom of the bond (IBond.getBegin()).
WedgedHashEnd	Display as a hashed wedge, with the narrow end towards the end atom of the bond (IBond.getEnd()).
WedgeEnd	Display as a bold wedge, with the narrow end towards the end atom of the bond (IBond.getEnd()).

Method Summary

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

Solid

public static final IBond.Display Solid

A solid line (default).

Dash

public static final IBond.Display Dash

A dashed line.

Hash

public static final IBond.Display Hash

A hashed line (bold dashed).

Bold

public static final IBond.Display Bold

A bold line.

Wavy

public static final IBond.Display Wavy

A wavy line.

Dot

public static final IBond.Display Dot

A dotted line.

WedgedHashBegin

public static final IBond.Display WedgedHashBegin

Display as a hashed wedge, with the narrow end towards the begin atom of the bond (IBond.getBegin()).

WedgedHashEnd

public static final IBond.Display WedgedHashEnd

Display as a hashed wedge, with the narrow end towards the end atom of the bond (IBond.getEnd()).

WedgeBegin

public static final IBond.Display WedgeBegin

Display as a bold wedge, with the narrow end towards the begin atom of the bond (IBond.getBegin()).

WedgeEnd

public static final IBond.Display WedgeEnd

Display as a bold wedge, with the narrow end towards the end atom of the bond (IBond.getEnd()).

ArrowBeg

public static final IBond.Display ArrowBeg

Display as an arrow (e.g. co-ordination bond), the arrow points to the begin (IBond.getBegin()) atom.

ArrowEnd

public static final IBond.Display ArrowEnd

Display as an arrow (e.g. co-ordination bond), the arrow points to the end (IBond.getEnd()) atom.

Method Detail

values

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