chemaxon.sss.search.options

Enum SetOfSmallestRingsOption

java.lang.Object

java.lang.Enum<SetOfSmallestRingsOption>

chemaxon.sss.search.options.SetOfSmallestRingsOption

All Implemented Interfaces:

chemaxon.sss.search.options.HasOptionString, java.io.Serializable, java.lang.Comparable<SetOfSmallestRingsOption>

@PublicAPI
public enum SetOfSmallestRingsOption
extends java.lang.Enum<SetOfSmallestRingsOption>
implements chemaxon.sss.search.options.HasOptionString

Option type describing the supported smallest set of rings used for property calculations.

Author:

JChem Base team, Vencel Bors

Enum Constant Summary

Enum Constants

Enum Constant and Description
CSSR Complete set of smallest rings.
SSSR Smallest set of smallest rings.

Method Summary

Modifier and Type	Method and Description
static SetOfSmallestRingsOption	fromString(java.lang.String str)
java.lang.String	getOptionString()
java.lang.String	toString()
static SetOfSmallestRingsOption	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SetOfSmallestRingsOption[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SSSR

public static final SetOfSmallestRingsOption SSSR

Smallest set of smallest rings.

CSSR

public static final SetOfSmallestRingsOption CSSR

Complete set of smallest rings.

Method Detail

values

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

Returns:

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

valueOf

public static SetOfSmallestRingsOption valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<SetOfSmallestRingsOption>

getOptionString

public java.lang.String getOptionString()

Specified by:

getOptionString in interface chemaxon.sss.search.options.HasOptionString

fromString

public static SetOfSmallestRingsOption fromString(java.lang.String str)