com.coyotegulch.itzam
Class Itzam

java.lang.Object
  extended by com.coyotegulch.itzam.Itzam
Direct Known Subclasses:
Btree, Datafile, HashTable

public class Itzam
extends java.lang.Object

A collection of general-purpose functions and values used throughout the Itzam/Java package.


Field Summary
static java.lang.String ABOUT
          Text that describes the purpose of Itzam/Java.
static long ITZAM_NULL_REF
          A file reference (position) the doesn't point to anything, used to mark empty list entries or to indicate that a record was not found.
static java.lang.String LICENSE
          "GNU Public License", the license governing the distribution and use of Jisp.
static java.lang.String VERSION
          Version number string.
 
Constructor Summary
Itzam()
           
 
Method Summary
static java.nio.ByteBuffer getBufferFor(Itzamable object)
          Retrieves an appropriately-sized buffer for the reading an instance of the given object.
static void main(java.lang.String[] args)
          The main function, run from itzam.jar to display version number and license.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ABOUT

public static final java.lang.String ABOUT
Text that describes the purpose of Itzam/Java.

See Also:
Constant Field Values

ITZAM_NULL_REF

public static final long ITZAM_NULL_REF
A file reference (position) the doesn't point to anything, used to mark empty list entries or to indicate that a record was not found.

See Also:
Constant Field Values

LICENSE

public static final java.lang.String LICENSE
"GNU Public License", the license governing the distribution and use of Jisp. This also contains a reference to the non-free license.

See Also:
Constant Field Values

VERSION

public static final java.lang.String VERSION
Version number string.

See Also:
Constant Field Values
Constructor Detail

Itzam

public Itzam()
Method Detail

getBufferFor

public static java.nio.ByteBuffer getBufferFor(Itzamable object)
Retrieves an appropriately-sized buffer for the reading an instance of the given object. The buffer will use the native byte order of the current platform; normally, Java defaults to big-endian order, but this would make Itzam/Java incompatible with other implementations of the engine.

Parameters:
object - The object for which a buffer is required.
Returns:
An appropriate buffer based on object

main

public static void main(java.lang.String[] args)
The main function, run from itzam.jar to display version number and license.

Parameters:
args - Program arguments (ignored)