Enum Class HaltOnErrorOption

java.lang.Object
java.lang.Enum<HaltOnErrorOption>
chemaxon.sss.search.options.HaltOnErrorOption
All Implemented Interfaces:
chemaxon.sss.search.options.HasOptionString, Serializable, Comparable<HaltOnErrorOption>, java.lang.constant.Constable

@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 Details

    • 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 Details

    • values

      public static HaltOnErrorOption[] 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 HaltOnErrorOption 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()
      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