Package chemaxon.sss.search.options

Enum HaltOnErrorOption

java.lang.Object

java.lang.Enum<HaltOnErrorOption>

chemaxon.sss.search.options.HaltOnErrorOption

All Implemented Interfaces:

chemaxon.sss.search.options.HasOptionString, Serializable, Comparable<HaltOnErrorOption>

@PublicAPI
public enum HaltOnErrorOption
extends Enum<HaltOnErrorOption>
implements chemaxon.sss.search.options.HasOptionString

Option type describing the error handling behaviour. Values: DEFAULT, YES, NO

Enum Constant Summary

Enum Constants

Enum Constant	Description
DEFAULT	Default error handling.
NO	Recover from record level errors if possible.
YES	Stop on any errors during the search.

Method Summary

Modifier and Type	Method	Description
static HaltOnErrorOption	fromString(String str)	Gets the halt on error option value for the string representation.
String	getOptionString()
String	toString()	Returns the string representation.
static HaltOnErrorOption	valueOf(String name)	Returns the enum constant of this type with the specified name.
static HaltOnErrorOption[]	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

DEFAULT

public static final HaltOnErrorOption DEFAULT

Default error handling. In case of Markush targets the search recovers from errors if possible. In case of other search targets the search stops on first error.

YES

public static final HaltOnErrorOption YES

Stop on any errors during the search.

NO

public static final HaltOnErrorOption NO

Recover from record level errors if possible. In case of general errors: incompatible query, query - search option pair or license error the search is stopped.

Method Detail

values

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

Returns:

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

valueOf

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

toString

public String toString()

Returns the string representation.

Overrides:

toString in class Enum<HaltOnErrorOption>

getOptionString

public String getOptionString()

Specified by:

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

fromString

public static HaltOnErrorOption fromString(String str)

Gets the halt on error option value for the string representation.

Parameters:

str - halt on error option string

Returns:

the halt on error option