com.intersys.cache.jni
Class CacheInternalArg

java.lang.Object
  extended bycom.intersys.cache.jni.CacheInternalArg

public class CacheInternalArg
extends Object

An opaque structure which represents a Cache' argument stack element. This is the data structure returned by CacheJNI.Pop(). The CacheJNI.Pop<type> functions are used to retrieve return values from CacheJNI functions which perform operations inside of Cache' that return a value (eg. Calling a COS function with CacheJNI.CallFunction()). These operations leave the return argument from Cache' on top of the internal Cache' argument stack. These arguments can be retrieved by any of the CacheJNI.Pop<type> functions which will convert the argument into the requested type and return it. Alternativly the argument can be retrieved with the CacheJNI.Pop() function which removes the argument from the stack but preserves its native type. The type of the argument can be inspected and the value retrieved as needed. The COS conversion rules apply to conversions between string and numeric data types. Note that if this functions reports that a piece of data has a string type, that does not mean that the data itself is not numeric. Numeric data in Cache' can be represented either in string form or in primitive form.


Constructor Summary
CacheInternalArg()
           
 
Method Summary
 double getDouble()
          Interprets the argument as an floating point number
 int getInt()
          Interprets the argument as an integer
 int getOref()
          Interprets the argument as a Cache' object reference.
 String getString()
          Interprets the argument as a string
 boolean isDouble()
          TRUE if the native Cache' type of the argument is a Cache' floating point number.
 boolean isInt()
          TRUE if the native Cache' type of the argument is an integer
 boolean isOref()
          TRUE if the native Cache' type of the argument is a Cache' object reference id.
 boolean isString()
          TRUE if the native Cache' type of the argument is a string.
 void main(String[] str)
          Creates a holder for the result of CacheJNI.Pop().
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CacheInternalArg

public CacheInternalArg()
Method Detail

isInt

public boolean isInt()
TRUE if the native Cache' type of the argument is an integer

Returns:
TRUE if the argument is stored as a native Cache' integer

isDouble

public boolean isDouble()
TRUE if the native Cache' type of the argument is a Cache' floating point number.

Returns:
TRUE if the argument is stored as a native Cache' floating point number.

isOref

public boolean isOref()
TRUE if the native Cache' type of the argument is a Cache' object reference id.

Returns:
TRUE if the argument is a Cache' object reference id.

isString

public boolean isString()
TRUE if the native Cache' type of the argument is a string.

Returns:
TRUE if the native Cache' type of the argument is a string.

getInt

public int getInt()
Interprets the argument as an integer

Returns:
the value of the argument as a Java Integer

getDouble

public double getDouble()
Interprets the argument as an floating point number

Returns:
the value of the argument as a Java Double number

getString

public String getString()
Interprets the argument as a string

Returns:
the value of the argument as a Java String

getOref

public int getOref()
Interprets the argument as a Cache' object reference.

Returns:
the value of the argument as a Java Integer

main

public void main(String[] str)
Creates a holder for the result of CacheJNI.Pop().

See Also:
CacheJNI.Pop()