Package org.openscience.cdk.depict

Enum Abbreviations.Option

java.lang.Object

java.lang.Enum<Abbreviations.Option>

org.openscience.cdk.depict.Abbreviations.Option

All Implemented Interfaces:

Serializable, Comparable<Abbreviations.Option>

Enclosing class:

Abbreviations

public static enum Abbreviations.Option
extends Enum<Abbreviations.Option>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALLOW_SINGLETON	Allow a structured to be collapsed to a single label.
AUTO_CONTRACT_HETERO	Automatically contract on hetero atoms, e.g.
AUTO_CONTRACT_LINKERS	On auto-contract to linker, e.g.
AUTO_CONTRACT_TERMINAL	Automatically contract on terminal atoms, e.g.

Method Summary

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

ALLOW_SINGLETON

public static final Abbreviations.Option ALLOW_SINGLETON

Allow a structured to be collapsed to a single label.

AUTO_CONTRACT_HETERO

public static final Abbreviations.Option AUTO_CONTRACT_HETERO

Automatically contract on hetero atoms, e.g. -NMe3

AUTO_CONTRACT_TERMINAL

public static final Abbreviations.Option AUTO_CONTRACT_TERMINAL

Automatically contract on terminal atoms, e.g. -CMe3. This will also allow contraction of symmetric abbreviations around a bond, e.g. Ph-Ph => Ph2

AUTO_CONTRACT_LINKERS

public static final Abbreviations.Option AUTO_CONTRACT_LINKERS

On auto-contract to linker, e.g. -S(=O)(=O)- => -S(O2)-

Method Detail

values

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

Returns:

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

valueOf

public static Abbreviations.Option 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