Package chemaxon.search.api.options

Enum Class HomologyTranslationOption

java.lang.Object

java.lang.Enum<HomologyTranslationOption>

chemaxon.search.api.options.HomologyTranslationOption

All Implemented Interfaces:

OptionStringProvider, Serializable, Comparable<HomologyTranslationOption>, Constable

@PublicApi
public enum HomologyTranslationOption
extends Enum<HomologyTranslationOption>
implements OptionStringProvider

Option type describing the scope of homology matching. Values: ALL and NONE.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	All atoms can have translation.
NONE	No atom can have translation.

Method Summary

Modifier and Type	Method	Description
static HomologyTranslationOption	fromString(String str)
String	getOptionString()
String	toString()
static HomologyTranslationOption	valueOf(String name)	Returns the enum constant of this class with the specified name.
static HomologyTranslationOption[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ALL

public static final HomologyTranslationOption ALL

All atoms can have translation.

NONE

public static final HomologyTranslationOption NONE

No atom can have translation.

Method Details

values

public static HomologyTranslationOption[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static HomologyTranslationOption valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<HomologyTranslationOption>

fromString

public static HomologyTranslationOption fromString(String str)

getOptionString

public String getOptionString()

Specified by:

getOptionString in interface OptionStringProvider