Enum OpsinResult.OPSIN_RESULT_STATUS

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<OpsinResult.OPSIN_RESULT_STATUS>
    Enclosing class:
    OpsinResult

    public static enum OpsinResult.OPSIN_RESULT_STATUS
    extends java.lang.Enum<OpsinResult.OPSIN_RESULT_STATUS>
    Whether parsing the chemical name was successful, encountered problems or was unsuccessful.
    If the result is not FAILURE then a structure has been generated
    Author:
    dl387
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      FAILURE
      OPSIN failed to interpret the name
      SUCCESS
      OPSIN successfully interpreted the name
      WARNING
      OPSIN interpreted the name but detected a potential problem e.g.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static OpsinResult.OPSIN_RESULT_STATUS valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static OpsinResult.OPSIN_RESULT_STATUS[] 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, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • WARNING

        public static final OpsinResult.OPSIN_RESULT_STATUS WARNING
        OPSIN interpreted the name but detected a potential problem e.g. could not interpret stereochemistry
        Currently, by default, WARNING is not used as stereochemistry failures are treated as failures
        In the future, ambiguous chemical names may produce WARNING
    • Method Detail

      • values

        public static OpsinResult.OPSIN_RESULT_STATUS[] 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 (OpsinResult.OPSIN_RESULT_STATUS c : OpsinResult.OPSIN_RESULT_STATUS.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static OpsinResult.OPSIN_RESULT_STATUS 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