chemaxon.sss.search.options
Enum HomologyTranslationOption

java.lang.Object
  java.lang.Enum<HomologyTranslationOption>
      chemaxon.sss.search.options.HomologyTranslationOption

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<HomologyTranslationOption>

public enum HomologyTranslationOption
extends java.lang.Enum<HomologyTranslationOption>

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

Author:

Robert Wagner

Enum Constant Summary

ALL
All atoms can have translation.

MARKED
Only marked atoms can have translation.

NONE
No atom can have translation.

Method Summary

static HomologyTranslationOption	fromString(java.lang.String str)
java.lang.String	toString()
static HomologyTranslationOption	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static HomologyTranslationOption[]	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

ALL

public static final HomologyTranslationOption ALL

All atoms can have translation.

MARKED

public static final HomologyTranslationOption MARKED

Only marked atoms can have translation. Not implemented yet, works as NONE.

NONE

public static final HomologyTranslationOption NONE

No atom can have translation.

Method Detail

values

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

Returns:

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

valueOf

public static HomologyTranslationOption 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<HomologyTranslationOption>

fromString

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