net.sf.jniinchi
Enum INCHI_KEY

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

public enum INCHI_KEY
extends Enum<INCHI_KEY>

Type-safe enumeration of InChI return codes.

InChI library return values:
OK (0) UNKNOWN_ERROR (1) EMPTY_INPUT (2) NOT_INCHI_INPUT (3) NOT_ENOUGH_MEMORY (4) ERROR_IN_FLAG_CHAR (5)

See inchi_api.h.

Author:
Sam Adams

Enum Constant Summary
EMPTY_INPUT
           
INVALID_INCHI
           
INVALID_INCHI_PREFIX
           
INVALID_STD_INCHI
           
NOT_ENOUGH_MEMORY
           
OK
           
UNKNOWN_ERROR
           
 
Method Summary
 int getIndx()
           
static INCHI_KEY getValue(int ret)
           
static INCHI_KEY valueOf(String name)
          Returns the enum constant of this type with the specified name.
static INCHI_KEY[] 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

OK

public static final INCHI_KEY OK

UNKNOWN_ERROR

public static final INCHI_KEY UNKNOWN_ERROR

EMPTY_INPUT

public static final INCHI_KEY EMPTY_INPUT

INVALID_INCHI_PREFIX

public static final INCHI_KEY INVALID_INCHI_PREFIX

NOT_ENOUGH_MEMORY

public static final INCHI_KEY NOT_ENOUGH_MEMORY

INVALID_INCHI

public static final INCHI_KEY INVALID_INCHI

INVALID_STD_INCHI

public static final INCHI_KEY INVALID_STD_INCHI
Method Detail

values

public static INCHI_KEY[] 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_KEY c : INCHI_KEY.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_KEY 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_KEY getValue(int ret)


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