Enum Class INCHI_RET

java.lang.Object
java.lang.Enum<INCHI_RET>
net.sf.jniinchi.INCHI_RET
All Implemented Interfaces:
Serializable, Comparable<INCHI_RET>, Constable

public enum INCHI_RET extends Enum<INCHI_RET>

Type-safe enumeration of InChI return codes.

InChI library return values:
SKIP (-2) Not used in InChI library
EOF (-1) No structural data has been provided
OKAY (0) Success, no errors or warnings
WARNING (1) Success, warning(s) issued
ERROR (2) Error: no InChI has been created
FATAL (3) Severe error: no InChI has been created (typically, memory allocation failure)
UNKNOWN (4) Unknown program error
BUSY (5) Previous call to InChI has not returned yet

See inchi_api.h.

  • 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
     
    Previuos call to InChI has not returned yet.
    No structural data has been provided.
    Error: no InChI has been created.
    Severe error: no InChI has been created (typically, memory allocation failure).
    Success; no errors or warnings.
    Not used in InChI library.
    Unknown program error.
    Success; warning(s) issued.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final int
    Internal InChI index (from inchi_api.h).
  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    INCHI_RET(int indx)
    Constructor.
  • Method Summary

    Modifier and Type
    Method
    Description
    int
     
    static INCHI_RET
    getValue(int ret)
     
    static INCHI_RET
    Returns the enum constant of this class with the specified name.
    static INCHI_RET[]
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Object

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

    • BREAK

      public static final INCHI_RET BREAK
    • SKIP

      public static final INCHI_RET SKIP
      Not used in InChI library.
    • EOF

      public static final INCHI_RET EOF
      No structural data has been provided.
    • OKAY

      public static final INCHI_RET OKAY
      Success; no errors or warnings.
    • WARNING

      public static final INCHI_RET WARNING
      Success; warning(s) issued.
    • ERROR

      public static final INCHI_RET ERROR
      Error: no InChI has been created.
    • FATAL

      public static final INCHI_RET FATAL
      Severe error: no InChI has been created (typically, memory allocation failure).
    • UNKNOWN

      public static final INCHI_RET UNKNOWN
      Unknown program error.
    • BUSY

      public static final INCHI_RET BUSY
      Previuos call to InChI has not returned yet.
  • Field Details

    • indx

      private final int indx
      Internal InChI index (from inchi_api.h).
  • Constructor Details

    • INCHI_RET

      private INCHI_RET(int indx)
      Constructor.
  • Method Details

    • values

      public static INCHI_RET[] 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 INCHI_RET 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
    • getIndx

      public int getIndx()
    • getValue

      public static INCHI_RET getValue(int ret)