net.sf.jniinchi
Enum INCHI_RET

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

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.

Author:
Sam Adams

Enum Constant Summary
BUSY
          Previuos call to InChI has not returned yet.
EOF
          No structural data has been provided.
ERROR
          Error: no InChI has been created.
FATAL
          Severe error: no InChI has been created (typically, memory allocation failure).
OKAY
          Success; no errors or warnings.
SKIP
          Not used in InChI library.
UNKNOWN
          Unknown program error.
WARNING
          Success; warning(s) issued.
 
Method Summary
 int getIndx()
           
static INCHI_RET getValue(int ret)
           
static INCHI_RET valueOf(String name)
          Returns the enum constant of this type with the specified name.
static INCHI_RET[] 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

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.

Method Detail

values

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

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

valueOf

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

getIndx

public int getIndx()

getValue

public static INCHI_RET getValue(int ret)


Copyright © 2006-2010 Sam Adams. All Rights Reserved.