JPack (Cumulus Java Classes Documentation)

java.lang.Object
- com.canto.cumulus.utils.JPack

All Implemented Interfaces:: java.io.Externalizable, java.io.Serializable

Direct Known Subclasses:: Pack

public class JPack
extends java.lang.Object
implements java.io.Externalizable

The JPack object provides a flexible way of storing structured data. It is a binary format that allows storing either atomic data of different types or lists and records of data. A record pack consists of items (which can be of different types) which are accessed by key. The key is a 32 bits integer usually built up from a 4 byte string. The conversion is done through a call to buildKey(String). A list pack consists of items (which can be of different types) which are accessed by index (starting at 0), like in a normal collection.
For example:

 //Create a list of users with the structure: { String:name, { int:nb, String:street}}
 int KEY_USER    = JPack.buildKey("User");
 int KEY_ADDRESS = JPack.buildKey("Addr");
 int KEY_STREET  = JPack.buildKey("User");
 int KEY_NUMBER  = JPack.buildKey("Numb");

 JPack users     = JPack.newListPack();
 JPack user      = JPack.newRecordPack();
 JPack home      = JPack.newRecordPack();

 user.putString( KEY_USER,   "John Doe");
 home.putInt(    KEY_NUMBER, 21);
 home.putString( KEY_STREET, "Nowhere Str.");
 user.putPackage(KEY_ADDRESS, home);
 users.putPackageAt(user);
 ...

 //Displays all users in the list
 for(int i = 0; i < users.countItems(); i++)
 {
      try
      {
          user = users.getPackageAt(i);
          home = user.getPackage(KEY_ADDRESS);
          System.out.println(user.getString(KEY_USER) + ": " + home.getInt(KEY_NUMBER) + " " +
 home.getString(KEY_STREET));
      }
      catch(JPack.NoSuchElementException e)
      {
      }
 }

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`JPack.InitializationEvent` The event object for the `JPack.InitializationListener`.
`static interface`	`JPack.InitializationListener` Listener for the initialization of a JPack instance.
`static class`	`JPack.JSONParser`
`class`	`JPack.NoSuchElementException`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`INTEL_BYTE_ORDER` Intel byte order (a.k.a. LSB first).
`static int`	`NATIVE_BYTE_ORDER` Native byte order of the running computer.
`static int`	`NETWORK_BYTE_ORDER` Network byte order (a.k.a. Motorola, MSB first).
`static int`	`PACK_TYPE_ALIAS` Pack type for a Mac OS Alias.
`static int`	`PACK_TYPE_BOOL` Pack type for a boolean.
`static int`	`PACK_TYPE_BYTE` Pack type for a byte or an array of bytes.
`static int`	`PACK_TYPE_DOUBLE` Pack type for a double (64 bits floating point).
`static int`	`PACK_TYPE_GUID` Pack type for a `GUID`.
`static int`	`PACK_TYPE_INT` Pack type for a 32 bits integer or an array of 32 bits integers.
`static int`	`PACK_TYPE_LIST` Pack type for a list pack.
`static int`	`PACK_TYPE_LOCAL_CHARS` Pack type for strings in local encoding.
`static int`	`PACK_TYPE_LONG` Pack type for a 64 bits integer or an array of 64 bits integers.
`static int`	`PACK_TYPE_RECORD` Pack type for a record pack.
`static int`	`PACK_TYPE_SHORT` Pack type for a 16 bits integer or an array of 16 bits integers.
`static int`	`PACK_TYPE_STRING` Pack type for a `String`.

Constructor Summary

Constructors
Constructor and Description

JPack()

JPack(byte[] initCore)
Creates a new JPack from a byte array.

JPack(java.lang.String xml)

Constructors
Constructor and Description
`JPack()`
`JPack(byte[] initCore)` Creates a new `JPack` from a byte array.
`JPack(java.lang.String xml)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addInitializationListener(JPack.InitializationListener listener)`
`static int`	`buildKey(java.lang.String s)` Converts a string to a record pack key (which is a 32-bits integer).
`int`	`countItems()` Returns the number of items in the pack.
`void`	`deleteItem(int key)` Deletes the item with the given key from the pack (Record packs only).
`void`	`deleteItemAt(int ulIndex)` Deletes the item at the given index (List packs only).
`boolean`	`equals(JPack pack)` Compares this pack to the specified pack.
`static JPack`	`fromJSON(java.lang.String json)` Create JPack instance from JSON formatted String.
`boolean`	`getBoolean(int key)` Return the item value with the given key as a boolean (Record packs only).
`boolean[]`	`getBooleanArray(int key)` Returns the item values with the given key as a boolean (Record packs only).
`boolean[]`	`getBooleanArrayAt(int index)` Returns the item value at the given index as an array of booleans (List packs only).
`boolean`	`getBooleanAt(int ulIndex)` Returns the item value at the given index as a boolean (List packs only).
`byte`	`getByte(int key)` Returns the item value with the given key as a byte (Record packs only).
`byte[]`	`getByteArray(int key)` Returns the item values with the given key as a byte (Record packs only).
`byte[]`	`getByteArrayAt(int index)` Returns the item value at the given index as an array of bytes (List packs only).
`byte`	`getByteAt(int ulIndex)` Returns the item value at the given index as a byte (List packs only).
`byte[]`	`getData()` Returns the pack content as a byte array in network byte order.
`byte[]`	`getData(int byteOrder)` Returns the pack content as a byte array in the specified byte order.
`int`	`getDataSize()` Returns the total size of the pack.
`double`	`getDouble(int key)` Return the item value with the given key as a double (Record packs only).
`double[]`	`getDoubleArray(int key)` Returns the item value with the given key as an array of doubles (Record packs only).
`double[]`	`getDoubleArrayAt(int index)` Returns the item value at the given index as an array of 64-bits integers (List packs only).
`double`	`getDoubleAt(int ulIndex)` Returns the item value at the given index as a double (List packs only).
`GUID`	`getGUID(int key)` Returns the item value with the given key as a `GUID` object (Record packs only).
`GUID[]`	`getGUIDArray(int key)` Returns the item value with the given key as an array of `GUIDs` (Record packs only).
`GUID[]`	`getGUIDArrayAt(int index)` Returns the item value at the given index as an array of GUIDs (List packs only).
`GUID`	`getGuidAt(int ulIndex)` Returns the item value at the given index as a `GUID` object (List packs only).
`int`	`getIndKey(int ulIndex)` Returns the key for an item by index (Record packs only).
`JPack.InitializationListener[]`	`getInitializationListeners()`
`int`	`getInt(int key)` Returns the item value with the given key as a 32-bits integer (Record packs only).
`int[]`	`getIntArray(int key)` Returns the item value with the given key as an array of 32-bits integers (Record packs only).
`int[]`	`getIntArrayAt(int index)` Returns the item value at the given index as an array of 32-bits integers (List packs only).
`int`	`getIntAt(int ulIndex)` Returns the item value at the given index as a 32-bits integer (List packs only).
`byte[]`	`getItemData(int key, int type)` Returns the data of the item with the given key (Record packs only).
`byte[]`	`getItemDataAt(int ulIndex, int type)` Returns the value of the item at the given index (List packs only).
`int`	`getItemSize(int key)` Returns the data size of the item with the given key (Record packs only).
`int`	`getItemSizeAt(int ulIndex)` Returns the data size of the item at the given index (List packs only).
`int`	`getItemType(int key)` Returns the data type of the item with the given key (Record packs only).
`int`	`getItemTypeAt(int ulIndex)` Returns the type of the item with the given index (List packs only).
`java.util.Iterator<JPack>`	`getListItemsIterator()` Returns an `Iterator` for iterating all contained Packs.
`long`	`getLong(int key)` Returns the item value with the given key as a 64-bits integer (Record packs only).
`long[]`	`getLongArray(int key)` Returns the item value with the given key as an array of 64-bits integers (Record packs only).
`long[]`	`getLongArrayAt(int index)` Returns the item value at the given index as an array of 64-bits integers (List packs only).
`long`	`getLongAt(int ulIndex)` Returns the item value at the given index as a 64-bits integer (List packs only).
`int`	`getOriginalByteOrder()`
`JPack`	`getPackage(int key)` Returns the item value with the given key as a `Pack` object (Record packs only).
`JPack`	`getPackageAt(int ulIndex)` Returns the item value at the given index as a `Pack<code> object (<b>List packs only</b>).`
`short`	`getShort(int key)` Returns the item value with the given key as a 16-bits integer (Record packs only).
`short[]`	`getShortArray(int key)` Returns the item values with the given key as a 16-bits integer (Record packs only).
`short[]`	`getShortArrayAt(int index)` Returns the item values with the given index as a 16-bits integer (Record packs only).
`short`	`getShortAt(int ulIndex)` Returns the item value at the given index as a 16-bits integer (List packs only).
`java.lang.String`	`getString(int key)` Returns the item value with the given key as a `String` (Record packs only).
`java.lang.String`	`getStringAt(int ulIndex)` Returns the item value at the given index as a `String` object (List packs only).
`int`	`getType()` Returns the pack type.
`java.lang.String`	`getXML()` Returns this pack as XML structure.
`boolean`	`hasItem(int key)` Return whethers the pack contains an item with the given key (Record packs only).
`void`	`initializeFromData(byte[] initCore)` Initializes a pack from a byte array.
`static java.lang.String`	`keyToString(int key)` Converts the given record pack key value to a string representation.
`static JPack`	`newListPack()` Creates a new empty list pack.
`static JPack`	`newRecordPack()` Creates a new empty record pack.
`void`	`prepareCache()`
`void`	`putBoolean(int key, boolean value)` Adds a new boolean item to the pack (Record packs only).
`void`	`putBooleanArray(int key, boolean[] value)` Adds a new array of booleans to the pack (Record packs only).
`void`	`putBooleanAt(boolean value)` Adds a new boolean item to the end of the pack (List packs only).
`void`	`putBooleanAt(boolean value, int ulIndex)` Inserts a new boolean item into the list at a given location (List packs only).
`void`	`putByte(int key, byte value)` Adds a new byte item to the pack (Record packs only).
`void`	`putByteArray(int key, byte[] value)` Adds a new array of bytes to the pack (Record packs only).
`void`	`putByteAt(byte value)` Adds a new byte item at the end of the pack (List packs only).
`void`	`putByteAt(byte value, int ulIndex)` Inserts a new byte item into the pack at a given index (List packs only).
`void`	`putDouble(int key, double value)` Adds a new double item to the pack (Record packs only).
`void`	`putDoubleArray(int key, double[] value)` Adds a new array of doubles to the pack (Record packs only).
`void`	`putDoubleAt(double value)` Adds a new double item at the end of the pack (List packs only).
`void`	`putDoubleAt(double value, int ulIndex)` Insert a new double item into the pack at a given index (List packs only).
`void`	`putGUID(int key, GUID value)` Adds a new `GUID` item to the pack (Record packs only).
`void`	`putGUIDArray(int key, GUID[] value)` Adds an array of `GUIDs` to the pack (Record packs only).
`void`	`putGUIDAt(GUID value)` Add a new `GUID` item at the end of the pack (List packs only).
`void`	`putGUIDAt(GUID value, int ulIndex)` Inserts a new `GUID` item into the pack at a given index (List packs only).
`void`	`putInt(int key, int value)` Adds a new 32-bits integer item to the pack (Record packs only).
`void`	`putIntArray(int key, int[] value)` Adds a new array of 32-bits integers to the pack (Record packs only).
`void`	`putIntAt(int value)` Adds a new 32-bits integer item at the end of the pack (List packs only).
`void`	`putIntAt(int value, int ulIndex)` Inserts a new 32-bits integer item into the pack at a given index (List packs only).
`void`	`putItemData(int key, int type, byte[] newItem)` Adds a new item to the pack (Record packs only).
`void`	`putItemDataAt(int type, byte[] ptr)` Adds a new item at the end of the pack (List packs only).
`void`	`putItemDataAt(int type, byte[] ptr, int ulIndex)` Inserts a new item into the pack at a given index (List packs only).
`void`	`putLong(int key, long value)` Adds a new 64-bits integer item to the pack (Record packs only).
`void`	`putLongArray(int key, long[] value)` Adds a new array of 64-bits integers to the pack (Record packs only).
`void`	`putLongAt(long value)` Add a new 64-bits integer item at the end of the pack (List packs only).
`void`	`putLongAt(long value, int ulIndex)` Inserts a new 64-bit integer item into the pack at a given index (List packs only).
`void`	`putPackage(int key, JPack pack)` Adds a new pack item to the pack (Record packs only).
`void`	`putPackageAt(JPack pack)` Adds a new `Pack` item at the end of the pack (List packs only).
`void`	`putPackageAt(JPack pack, int ulIndex)` Inserts a new `Pack` item into the pack at a given index (List packs only).
`void`	`putShort(int key, short value)` Adds a new 16-bits integer item to the pack (Record packs only).
`void`	`putShortArray(int key, short[] value)` Adds a new array of 16-bits integers to the pack (Record packs only).
`void`	`putShortAt(short value)` Add a new 16-bits integer item at the end of the pack (List packs only).
`void`	`putShortAt(short value, int ulIndex)` Inserts a new 16-bits integer item into the pack at a given index (List packs only).
`void`	`putString(int key, java.lang.String value)` Adds a new `String` item to the pack (Record packs only).
`void`	`putStringAt(java.lang.String value)` Adds a new `String` item at the end of the pack (List packs only).
`void`	`putStringAt(java.lang.String value, int ulIndex)` Inserts a new `String` item into the pack at a given index (List packs only).
`void`	`readExternal(java.io.ObjectInput in)`
`void`	`removeInitializationListener(JPack.InitializationListener listener)`
`java.lang.String`	`toString()`
`void`	`writeExternal(java.io.ObjectOutput out)`
`void`	`writeXML(java.io.OutputStream outputStream)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - PACK_TYPE_LIST
```
public static final int PACK_TYPE_LIST
```
    Pack type for a list pack.
    
    See Also:
    Constant Field Values
  - PACK_TYPE_RECORD
```
public static final int PACK_TYPE_RECORD
```
    Pack type for a record pack.
    
    See Also:
    Constant Field Values
  - PACK_TYPE_STRING
```
public static final int PACK_TYPE_STRING
```
    Pack type for a String.
    
    See Also:
    Constant Field Values
  - PACK_TYPE_INT
```
public static final int PACK_TYPE_INT
```
    Pack type for a 32 bits integer or an array of 32 bits integers.
    
    See Also:
    Constant Field Values
  - PACK_TYPE_LONG
```
public static final int PACK_TYPE_LONG
```
    Pack type for a 64 bits integer or an array of 64 bits integers.
    
    See Also:
    Constant Field Values
  - PACK_TYPE_SHORT
```
public static final int PACK_TYPE_SHORT
```
    Pack type for a 16 bits integer or an array of 16 bits integers.
    
    See Also:
    Constant Field Values
  - PACK_TYPE_BYTE
```
public static final int PACK_TYPE_BYTE
```
    Pack type for a byte or an array of bytes.
    
    See Also:
    Constant Field Values
  - PACK_TYPE_BOOL
```
public static final int PACK_TYPE_BOOL
```
    Pack type for a boolean.
    
    See Also:
    Constant Field Values
  - PACK_TYPE_GUID
```
public static final int PACK_TYPE_GUID
```
    Pack type for a GUID.
    
    See Also:
    Constant Field Values
  - PACK_TYPE_DOUBLE
```
public static final int PACK_TYPE_DOUBLE
```
    Pack type for a double (64 bits floating point).
    
    See Also:
    Constant Field Values
  - PACK_TYPE_ALIAS
```
public static final int PACK_TYPE_ALIAS
```
    Pack type for a Mac OS Alias.
    
    See Also:
    Constant Field Values
  - PACK_TYPE_LOCAL_CHARS
```
public static final int PACK_TYPE_LOCAL_CHARS
```
    Pack type for strings in local encoding. The recommended type for storing strings is PACK_TYPE_STRING as it is based on UNICODE characters.
    
    See Also:
    Constant Field Values
  - NETWORK_BYTE_ORDER
```
public static final int NETWORK_BYTE_ORDER
```
    Network byte order (a.k.a. Motorola, MSB first).
    
    See Also:
    Constant Field Values
  - INTEL_BYTE_ORDER
```
public static final int INTEL_BYTE_ORDER
```
    Intel byte order (a.k.a. LSB first).
    
    See Also:
    Constant Field Values
  - NATIVE_BYTE_ORDER
```
public static final int NATIVE_BYTE_ORDER
```
    Native byte order of the running computer.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - JPack
```
public JPack()
```
  - JPack
```
public JPack(byte[] initCore)
```
    Creates a new JPack from a byte array.
    
    Parameters:
    initCore - the JPack as byte array.
  - JPack
```
public JPack(java.lang.String xml)
```
- Method Detail
  - prepareCache
```
public void prepareCache()
```
  - countItems
```
public final int countItems()
```
    Returns the number of items in the pack.
    
    Returns:
    the number of items in the pack.
  - getType
```
public final int getType()
```
    Returns the pack type.
    
    Returns:
    the pack type.
  - getDataSize
```
public final int getDataSize()
```
    Returns the total size of the pack.
    
    Returns:
    the total size of the pack.
  - getData
```
public final byte[] getData()
```
    Returns the pack content as a byte array in network byte order.
    
    Returns:
    the pack content as a byte array in network byte order.
  - getData
```
public final byte[] getData(int byteOrder)
```
    Returns the pack content as a byte array in the specified byte order.
    Parameters:
    byteOrder - the byte order. Possible values are:
    
    NETWORK_BYTE_ORDER
    
    INTEL_BYTE_ORDER
    
    NATIVE_BYTE_ORDER
    Returns:
    the pack content as a byte array in the specified byte order.
  - getIndKey
```
public final int getIndKey(int ulIndex)
                    throws JPack.NoSuchElementException
```
    Returns the key for an item by index (Record packs only). With this method, you can retrieve all the keys of the items contained in a record pack.
    
    Parameters:
    ulIndex - the item index.
    
    Returns:
    the key of the item at the specified index.
    
    Throws:
    
    NoSuchElementException - if there is no item at the specified index.
    
    JPack.NoSuchElementException
  - hasItem
```
public final boolean hasItem(int key)
```
    Return whethers the pack contains an item with the given key (Record packs only).
    
    Parameters:
    key - the key to look for
    
    Returns:
    true if an item with the specified key is in the pack; false otherwise.
  - getItemType
```
public final int getItemType(int key)
                      throws JPack.NoSuchElementException
```
    Returns the data type of the item with the given key (Record packs only).
    
    Parameters:
    key - the item key.
    
    Returns:
    the item type (see constants above).
    
    Throws:
    
    NoSuchElementException - if there is no item with the specified key.
    
    JPack.NoSuchElementException
  - getItemSize
```
public final int getItemSize(int key)
                      throws JPack.NoSuchElementException
```
    Returns the data size of the item with the given key (Record packs only).
    
    Parameters:
    key - the item key.
    
    Returns:
    the data size of the item.
    
    Throws:
    
    NoSuchElementException - if there is no item with the specified key.
    
    JPack.NoSuchElementException
  - getItemData
```
public final byte[] getItemData(int key,
                 int type)
                         throws JPack.NoSuchElementException,
                                InvalidTypeException
```
    Returns the data of the item with the given key (Record packs only).
    
    Parameters:
    key - the item key.
    type - the item type.
    
    Returns:
    the data of the item as a byte array.
    
    Throws:
    
    NoSuchElementException - if there is no item with the specified key.
    
    InvalidTypeException - if the item type doesn't match the specified one.
    
    JPack.NoSuchElementException
  - initializeFromData
```
public final void initializeFromData(byte[] initCore)
```
    Initializes a pack from a byte array.
    
    Parameters:
    initCore - the pack as byte array.
  - getOriginalByteOrder
```
public int getOriginalByteOrder()
```
  - newRecordPack
```
public static JPack newRecordPack()
```
    Creates a new empty record pack.
    
    Returns:
    a new empty record pack.
  - newListPack
```
public static JPack newListPack()
```
    Creates a new empty list pack.
    
    Returns:
    a new empty list pack.
  - getPackage
```
public final JPack getPackage(int key)
                       throws JPack.NoSuchElementException
```
    Returns the item value with the given key as a Pack object (Record packs only).
    
    Parameters:
    key - the item key.
    
    Returns:
    the item value as a Pack object.
    
    Throws:
    
    NoSuchElementException - if there is no item with the specified key.
    
    JPack.NoSuchElementException
  - getBoolean
```
public final boolean getBoolean(int key)
                         throws JPack.NoSuchElementException
```
    Return the item value with the given key as a boolean (Record packs only).
    
    Parameters:
    key - the item key.
    
    Returns:
    the item value as a boolean.
    
    Throws:
    
    NoSuchElementException - if there is no item with the specified key.
    
    JPack.NoSuchElementException
  - getByte
```
public final byte getByte(int key)
                   throws JPack.NoSuchElementException
```
    Returns the item value with the given key as a byte (Record packs only).
    
    Parameters:
    key - the item key.
    
    Returns:
    the item value as a byte.
    
    Throws:
    
    NoSuchElementException - if there is no item with the specified key.
    
    JPack.NoSuchElementException
  - getShort
```
public final short getShort(int key)
                     throws JPack.NoSuchElementException
```
    Returns the item value with the given key as a 16-bits integer (Record packs only).
    
    Parameters:
    key - the item key.
    
    Returns:
    the item value as a 16-bits integer.
    
    Throws:
    
    NoSuchElementException - if there is no item with the specified key.
    
    JPack.NoSuchElementException
  - getShortArray
```
public final short[] getShortArray(int key)
                            throws JPack.NoSuchElementException
```
    Returns the item values with the given key as a 16-bits integer (Record packs only).
    
    Parameters:
    key - the item key.
    
    Returns:
    the item values as a 16-bits integers.
    
    Throws:
    
    NoSuchElementException - if there is no item with the specified key.
    
    JPack.NoSuchElementException
    Since:
    
    8.0
  - getShortArrayAt
```
public final short[] getShortArrayAt(int index)
                              throws JPack.NoSuchElementException
```
    Returns the item values with the given index as a 16-bits integer (Record packs only).
    
    Parameters:
    index - the item index
    
    Returns:
    the item values as a 16-bits integers.
    
    Throws:
    
    NoSuchElementException - if there is no item at the specified index
    
    JPack.NoSuchElementException
    Since:
    
    8.0
  - getByteArray
```
public final byte[] getByteArray(int key)
                          throws JPack.NoSuchElementException
```
    Returns the item values with the given key as a byte (Record packs only).
    
    Parameters:
    key - the item key.
    
    Returns:
    the item values as a bytes.
    
    Throws:
    
    NoSuchElementException - if there is no item with the specified key.
    
    JPack.NoSuchElementException
    Since:
    
    8.0
  - getBooleanArray
```
public final boolean[] getBooleanArray(int key)
                                throws JPack.NoSuchElementException
```
    Returns the item values with the given key as a boolean (Record packs only).
    
    Parameters:
    key - the item key.
    
    Returns:
    the item values as a booleans.
    
    Throws:
    
    NoSuchElementException - if there is no item with the specified key.
    
    JPack.NoSuchElementException
    Since:
    
    8.0
  - getInt
```
public final int getInt(int key)
                 throws JPack.NoSuchElementException
```
    Returns the item value with the given key as a 32-bits integer (Record packs only).
    
    Parameters:
    key - the item key.
    
    Returns:
    the item value as a 32-bits integer.
    
    Throws:
    
    NoSuchElementException - if there is no item with the specified key.
    
    JPack.NoSuchElementException
  - getIntArray
```
public final int[] getIntArray(int key)
                        throws JPack.NoSuchElementException
```
    Returns the item value with the given key as an array of 32-bits integers (Record packs only).
    
    Parameters:
    key - the item key.
    
    Returns:
    the item value as an array of 32-bits integers
    
    Throws:
    
    NoSuchElementException - if there is no item with the specified key.
    
    JPack.NoSuchElementException
  - getLong
```
public final long getLong(int key)
                   throws JPack.NoSuchElementException
```
    Returns the item value with the given key as a 64-bits integer (Record packs only).
    
    Parameters:
    key - the item key.
    
    Returns:
    the item value as a 64-bits integer.
    
    Throws:
    
    NoSuchElementException - if there is no item with the specified key.
    
    JPack.NoSuchElementException
  - getLongArray
```
public final long[] getLongArray(int key)
                          throws JPack.NoSuchElementException
```
    Returns the item value with the given key as an array of 64-bits integers (Record packs only).
    
    Parameters:
    key - the item key.
    
    Returns:
    the item value as an array of 64-bits integers.
    
    Throws:
    
    NoSuchElementException - if there is no item with the specified key.
    
    JPack.NoSuchElementException
    Since:
    
    6.6
  - getLongArrayAt
```
public final long[] getLongArrayAt(int index)
                            throws JPack.NoSuchElementException
```
    Returns the item value at the given index as an array of 64-bits integers (List packs only).
    
    Parameters:
    index - the item index.
    
    Returns:
    the item value as an array of 64-bits integers.
    
    Throws:
    
    NoSuchElementException - if there is no item at the specified index.
    
    JPack.NoSuchElementException
    Since:
    
    8.0
  - getIntArrayAt
```
public final int[] getIntArrayAt(int index)
                          throws JPack.NoSuchElementException
```
    Returns the item value at the given index as an array of 32-bits integers (List packs only).
    
    Parameters:
    index - the item index.
    
    Returns:
    the item value as an array of 32-bits integers.
    
    Throws:
    
    NoSuchElementException - if there is no item at the specified index.
    
    JPack.NoSuchElementException
    Since:
    
    8.0
  - getDoubleArrayAt
```
public final double[] getDoubleArrayAt(int index)
                                throws JPack.NoSuchElementException
```
    Returns the item value at the given index as an array of 64-bits integers (List packs only).
    
    Parameters:
    index - the item index.
    
    Returns:
    the item value as an array of 64-bits integers.
    
    Throws:
    
    NoSuchElementException - if there is no item at the specified index.
    
    JPack.NoSuchElementException
    Since:
    
    8.0
  - getGUIDArrayAt
```
public final GUID[] getGUIDArrayAt(int index)
                            throws JPack.NoSuchElementException
```
    Returns the item value at the given index as an array of GUIDs (List packs only).
    
    Parameters:
    index - the item index.
    
    Returns:
    the item value as an array of GUIDs.
    
    Throws:
    
    NoSuchElementException - if there is no item at the specified index.
    
    JPack.NoSuchElementException
    Since:
    
    8.0
  - getBooleanArrayAt
```
public final boolean[] getBooleanArrayAt(int index)
                                  throws JPack.NoSuchElementException
```
    Returns the item value at the given index as an array of booleans (List packs only).
    
    Parameters:
    index - the item index.
    
    Returns:
    the item value as an array of booleans.
    
    Throws:
    
    NoSuchElementException - if there is no item at the specified index.
    
    JPack.NoSuchElementException
    Since:
    
    8.0
  - getByteArrayAt
```
public final byte[] getByteArrayAt(int index)
                            throws JPack.NoSuchElementException
```
    Returns the item value at the given index as an array of bytes (List packs only).
    
    Parameters:
    index - the item index.
    
    Returns:
    the item value as an array of bytes.
    
    Throws:
    
    NoSuchElementException - if there is no item at the specified index.
    
    JPack.NoSuchElementException
    Since:
    
    8.0
  - getDouble
```
public final double getDouble(int key)
                       throws JPack.NoSuchElementException
```
    Return the item value with the given key as a double (Record packs only).
    
    Parameters:
    key - the item key.
    
    Returns:
    the item value as a double.
    
    Throws:
    
    NoSuchElementException - if there is no item with the specified key.
    
    JPack.NoSuchElementException
  - getDoubleArray
```
public final double[] getDoubleArray(int key)
                              throws JPack.NoSuchElementException
```
    Returns the item value with the given key as an array of doubles (Record packs only).
    
    Parameters:
    key - the item key.
    
    Returns:
    the item value as an array of doubles.
    
    Throws:
    
    NoSuchElementException - if there is no item with the specified key.
    
    JPack.NoSuchElementException
    Since:
    
    6.6
  - getGUID
```
public final GUID getGUID(int key)
                   throws JPack.NoSuchElementException
```
    Returns the item value with the given key as a GUID object (Record packs only).
    
    Parameters:
    key - the item key.
    
    Returns:
    the item value as a GUID object.
    
    Throws:
    
    NoSuchElementException - if there is no item with the specified key.
    
    JPack.NoSuchElementException
  - getGUIDArray
```
public final GUID[] getGUIDArray(int key)
                          throws JPack.NoSuchElementException
```
    Returns the item value with the given key as an array of GUIDs (Record packs only).
    
    Parameters:
    key - the item key.
    
    Returns:
    the item value as an array of GUIDs.
    
    Throws:
    
    NoSuchElementException - if there is no item with the specified key.
    
    JPack.NoSuchElementException
    Since:
    
    6.5
  - putGUIDArray
```
public final void putGUIDArray(int key,
                GUID[] value)
```
    Adds an array of GUIDs to the pack (Record packs only).
    
    Parameters:
    key - the item key.
    value - an array of GUIDs.
    Since:
    
    6.5
  - getString
```
public final java.lang.String getString(int key)
                                 throws JPack.NoSuchElementException
```
    Returns the item value with the given key as a String (Record packs only).
    
    Parameters:
    key - the item key.
    
    Returns:
    the item value as a String.
    
    Throws:
    
    NoSuchElementException - if there is no item with the specified key.
    
    JPack.NoSuchElementException
  - deleteItem
```
public final void deleteItem(int key)
```
    Deletes the item with the given key from the pack (Record packs only).
    
    Parameters:
    key - the item key.
  - putItemData
```
public final void putItemData(int key,
               int type,
               byte[] newItem)
```
    Adds a new item to the pack (Record packs only).
    
    Parameters:
    key - the item key.
    type - the item type (see constants above).
    newItem - the item value as a byte array.
  - putPackage
```
public final void putPackage(int key,
              JPack pack)
```
    Adds a new pack item to the pack (Record packs only).
    
    Parameters:
    key - the item key.
    pack - the pack to add.
  - putBoolean
```
public final void putBoolean(int key,
              boolean value)
```
    Adds a new boolean item to the pack (Record packs only).
    
    Parameters:
    key - the item key.
    value - the boolean to add.
  - putByte
```
public final void putByte(int key,
           byte value)
```
    Adds a new byte item to the pack (Record packs only).
    
    Parameters:
    key - the item key.
    value - the byte to add.
  - putShort
```
public final void putShort(int key,
            short value)
```
    Adds a new 16-bits integer item to the pack (Record packs only).
    
    Parameters:
    key - the item key.
    value - the 16-bits integer to add.
  - putInt
```
public final void putInt(int key,
          int value)
```
    Adds a new 32-bits integer item to the pack (Record packs only).
    
    Parameters:
    key - the item key.
    value - the 32-bits integer to add.
  - putIntArray
```
public final void putIntArray(int key,
               int[] value)
```
    Adds a new array of 32-bits integers to the pack (Record packs only).
    
    Parameters:
    key - the item key.
    value - the array of 32-bits integers to add.
    Since:
    
    6.0.1
  - putLong
```
public final void putLong(int key,
           long value)
```
    Adds a new 64-bits integer item to the pack (Record packs only).
    
    Parameters:
    key - the item key.
    value - the 64-bits integer to add.
  - putLongArray
```
public final void putLongArray(int key,
                long[] value)
```
    Adds a new array of 64-bits integers to the pack (Record packs only).
    
    Parameters:
    key - the item key.
    value - the array of 64-bits integers to add.
    Since:
    
    6.6
  - putBooleanArray
```
public final void putBooleanArray(int key,
                   boolean[] value)
```
    Adds a new array of booleans to the pack (Record packs only).
    
    Parameters:
    key - the item key.
    value - the array of booleans to add.
    Since:
    
    8.0
  - putByteArray
```
public final void putByteArray(int key,
                byte[] value)
```
    Adds a new array of bytes to the pack (Record packs only).
    
    Parameters:
    key - the item key.
    value - the array of bytes to add.
    Since:
    
    8.0
  - putShortArray
```
public final void putShortArray(int key,
                 short[] value)
```
    Adds a new array of 16-bits integers to the pack (Record packs only).
    
    Parameters:
    key - the item key.
    value - the array of 16-bits integers to add.
    Since:
    
    8.0
  - putDouble
```
public final void putDouble(int key,
             double value)
```
    Adds a new double item to the pack (Record packs only).
    
    Parameters:
    key - the item key.
    value - the double to add.
  - putDoubleArray
```
public final void putDoubleArray(int key,
                  double[] value)
```
    Adds a new array of doubles to the pack (Record packs only).
    
    Parameters:
    key - the item key.
    value - the array of doubles to add.
    Since:
    
    6.6
  - putGUID
```
public final void putGUID(int key,
           GUID value)
```
    Adds a new GUID item to the pack (Record packs only).
    
    Parameters:
    key - the item key.
    value - the GUID to add.
  - putString
```
public final void putString(int key,
             java.lang.String value)
```
    Adds a new String item to the pack (Record packs only).
    
    Parameters:
    key - the item key.
    value - the String to add.
  - buildKey
```
public static int buildKey(java.lang.String s)
```
    Converts a string to a record pack key (which is a 32-bits integer).
    
    Parameters:
    s - the key as a string. This string must contain exactly 4 characters.
    
    Returns:
    a new pack key.
  - getListItemsIterator
```
public java.util.Iterator<JPack> getListItemsIterator()
```
    Returns an Iterator for iterating all contained Packs. This pack must not contain any other types except packs! This method throws an UnsupportedOperationException when called on a record pack.
    
    Returns:
    Iterator (without Iterator.remove()-support) for iterating all sub-packs of this list pack
    Since:
    
    6.5
  - getItemTypeAt
```
public final int getItemTypeAt(int ulIndex)
                        throws JPack.NoSuchElementException
```
    Returns the type of the item with the given index (List packs only).
    
    Parameters:
    ulIndex - the item index.
    
    Returns:
    the item type (see constants above).
    
    Throws:
    
    NoSuchElementException - if there is no item at the given index.
    
    JPack.NoSuchElementException
  - getItemSizeAt
```
public final int getItemSizeAt(int ulIndex)
                        throws JPack.NoSuchElementException
```
    Returns the data size of the item at the given index (List packs only).
    
    Parameters:
    ulIndex - the item index.
    
    Returns:
    the data size of the item.
    
    Throws:
    
    NoSuchElementException - if there is no item at the given index.
    
    JPack.NoSuchElementException
  - getItemDataAt
```
public final byte[] getItemDataAt(int ulIndex,
                   int type)
                           throws JPack.NoSuchElementException,
                                  InvalidTypeException
```
    Returns the value of the item at the given index (List packs only).
    
    Parameters:
    ulIndex - the item index.
    type - content type
    
    Returns:
    the value of the specified item as a byte array.
    
    Throws:
    
    NoSuchElementException - if there is no item at the given index.
    
    InvalidTypeException - if the item type doesn't match the specified one.
    
    JPack.NoSuchElementException
  - getPackageAt
```
public final JPack getPackageAt(int ulIndex)
                         throws JPack.NoSuchElementException
```
    Returns the item value at the given index as a Pack<code> object (<b>List packs only</b>).
    
    Parameters:
    ulIndex - the item index.
    
    Returns:
    the item value as a Pack<code> object.
    
    Throws:
    
    NoSuchElementException - if there is no item at the given index.
    
    JPack.NoSuchElementException
  - getBooleanAt
```
public final boolean getBooleanAt(int ulIndex)
                           throws JPack.NoSuchElementException
```
    Returns the item value at the given index as a boolean (List packs only).
    
    Parameters:
    ulIndex - the item index.
    
    Returns:
    the item value as a boolean.
    
    Throws:
    
    NoSuchElementException - if there is no item at the given index.
    
    JPack.NoSuchElementException
  - getByteAt
```
public final byte getByteAt(int ulIndex)
                     throws JPack.NoSuchElementException
```
    Returns the item value at the given index as a byte (List packs only).
    
    Parameters:
    ulIndex - the item index.
    
    Returns:
    the item value as a byte.
    
    Throws:
    
    NoSuchElementException - if there is no item at the given index.
    
    JPack.NoSuchElementException
  - getShortAt
```
public final short getShortAt(int ulIndex)
                       throws JPack.NoSuchElementException
```
    Returns the item value at the given index as a 16-bits integer (List packs only).
    
    Parameters:
    ulIndex - the item index.
    
    Returns:
    the item value as a 16-bits integer.
    
    Throws:
    
    NoSuchElementException - if there is no item at the given index.
    
    JPack.NoSuchElementException
  - getIntAt
```
public final int getIntAt(int ulIndex)
                   throws JPack.NoSuchElementException
```
    Returns the item value at the given index as a 32-bits integer (List packs only).
    
    Parameters:
    ulIndex - the item index.
    
    Returns:
    the item value at the given index as a 32-bits integer.
    
    Throws:
    
    NoSuchElementException - if there is no item at the given index.
    
    JPack.NoSuchElementException
  - getLongAt
```
public final long getLongAt(int ulIndex)
                     throws JPack.NoSuchElementException
```
    Returns the item value at the given index as a 64-bits integer (List packs only).
    
    Parameters:
    ulIndex - the item index.
    
    Returns:
    the item value at the given index as a 64-bits integer.
    
    Throws:
    
    NoSuchElementException - if there is no item at the given index.
    
    JPack.NoSuchElementException
  - getGuidAt
```
public final GUID getGuidAt(int ulIndex)
                     throws JPack.NoSuchElementException
```
    Returns the item value at the given index as a GUID object (List packs only).
    
    Parameters:
    ulIndex - the item index.
    
    Returns:
    the item value at the given index as a GUID object.
    
    Throws:
    
    NoSuchElementException - if there is no item at the given index.
    
    JPack.NoSuchElementException
    Since:
    
    6.6
  - getDoubleAt
```
public final double getDoubleAt(int ulIndex)
                         throws JPack.NoSuchElementException
```
    Returns the item value at the given index as a double (List packs only).
    
    Parameters:
    ulIndex - the item index.
    
    Returns:
    the item value at the given index as a double.
    
    Throws:
    
    NoSuchElementException - if there is no item at the given index.
    
    JPack.NoSuchElementException
  - getStringAt
```
public final java.lang.String getStringAt(int ulIndex)
                                   throws JPack.NoSuchElementException
```
    Returns the item value at the given index as a String object (List packs only).
    
    Parameters:
    ulIndex - the item index.
    
    Returns:
    the item value as a String object.
    
    Throws:
    
    NoSuchElementException - if there is no item at the given index.
    
    JPack.NoSuchElementException
  - deleteItemAt
```
public final void deleteItemAt(int ulIndex)
                        throws JPack.NoSuchElementException
```
    Deletes the item at the given index (List packs only).
    
    Parameters:
    ulIndex - the item index.
    
    Throws:
    
    NoSuchElementException - if there is no item at the given index.
    
    JPack.NoSuchElementException
  - putItemDataAt
```
public final void putItemDataAt(int type,
                 byte[] ptr)
```
    Adds a new item at the end of the pack (List packs only).
    
    Parameters:
    type - the item type (see constants above).
    ptr - the item value as a byte array.
  - putItemDataAt
```
public final void putItemDataAt(int type,
                 byte[] ptr,
                 int ulIndex)
```
    Inserts a new item into the pack at a given index (List packs only).
    
    Parameters:
    type - the item type (see constants above).
    ptr - the item value as a byte array.
    ulIndex - the index where to insert the item.
  - putPackageAt
```
public final void putPackageAt(JPack pack)
```
    Adds a new Pack item at the end of the pack (List packs only).
    
    Parameters:
    pack - the pack item.
  - putPackageAt
```
public final void putPackageAt(JPack pack,
                int ulIndex)
```
    Inserts a new Pack item into the pack at a given index (List packs only).
    
    Parameters:
    pack - the pack to add.
    ulIndex - the index where to insert the item
  - putBooleanAt
```
public final void putBooleanAt(boolean value)
```
    Adds a new boolean item to the end of the pack (List packs only).
    
    Parameters:
    value - the boolean to add.
  - putBooleanAt
```
public final void putBooleanAt(boolean value,
                int ulIndex)
```
    Inserts a new boolean item into the list at a given location (List packs only).
    
    Parameters:
    value - the boolean to add.
    ulIndex - the index where to insert the item.
  - putByteAt
```
public final void putByteAt(byte value)
```
    Adds a new byte item at the end of the pack (List packs only).
    
    Parameters:
    value - the byte to add.
  - putByteAt
```
public final void putByteAt(byte value,
             int ulIndex)
```
    Inserts a new byte item into the pack at a given index (List packs only).
    
    Parameters:
    value - the byte to add.
    ulIndex - the index where to insert the item.
  - putShortAt
```
public final void putShortAt(short value)
```
    Add a new 16-bits integer item at the end of the pack (List packs only).
    
    Parameters:
    value - the 16-bits integer to add.
  - putShortAt
```
public final void putShortAt(short value,
              int ulIndex)
```
    Inserts a new 16-bits integer item into the pack at a given index (List packs only).
    
    Parameters:
    value - the 16-bits integer to add.
    ulIndex - the index where to insert the item.
  - putIntAt
```
public final void putIntAt(int value)
```
    Adds a new 32-bits integer item at the end of the pack (List packs only).
    
    Parameters:
    value - the 32-bits integer to add.
  - putIntAt
```
public final void putIntAt(int value,
            int ulIndex)
```
    Inserts a new 32-bits integer item into the pack at a given index (List packs only).
    
    Parameters:
    value - the 32-bits integer to add.
    ulIndex - the index where to insert the item.
  - putLongAt
```
public final void putLongAt(long value)
```
    Add a new 64-bits integer item at the end of the pack (List packs only).
    
    Parameters:
    value - the 64-bits integer to add.
  - putLongAt
```
public final void putLongAt(long value,
             int ulIndex)
```
    Inserts a new 64-bit integer item into the pack at a given index (List packs only).
    
    Parameters:
    value - the 64-bits integer to add.
    ulIndex - the index where to insert the item .
  - putGUIDAt
```
public final void putGUIDAt(GUID value)
```
    Add a new GUID item at the end of the pack (List packs only).
    
    Parameters:
    value - the GUID to add.
  - putGUIDAt
```
public final void putGUIDAt(GUID value,
             int ulIndex)
```
    Inserts a new GUID item into the pack at a given index (List packs only).
    
    Parameters:
    value - the GUID to add.
    ulIndex - the index where to insert the item.
  - putDoubleAt
```
public final void putDoubleAt(double value)
```
    Adds a new double item at the end of the pack (List packs only).
    
    Parameters:
    value - the double to add.
  - putDoubleAt
```
public final void putDoubleAt(double value,
               int ulIndex)
```
    Insert a new double item into the pack at a given index (List packs only).
    
    Parameters:
    value - the double to add.
    ulIndex - the index where to insert the item.
  - putStringAt
```
public final void putStringAt(java.lang.String value)
```
    Adds a new String item at the end of the pack (List packs only).
    
    Parameters:
    value - the String to add.
  - putStringAt
```
public final void putStringAt(java.lang.String value,
               int ulIndex)
```
    Inserts a new String item into the pack at a given index (List packs only).
    
    Parameters:
    value - the String to add.
    ulIndex - the index where to insert the item
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getXML
```
public java.lang.String getXML()
```
    Returns this pack as XML structure.
    
    Returns:
    this pack as XML structure
    Since:
    
    8.0
  - writeXML
```
public void writeXML(java.io.OutputStream outputStream)
              throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - fromJSON
```
public static JPack fromJSON(java.lang.String json)
```
    Create JPack instance from JSON formatted String. For record packs the hashCode value of the given JSON key is used as pack key. Empty or null input results in an empty record pack.
    
    Parameters:
    json - String in valid json format that should be parsed into a JPack
    
    Returns:
    created JPack
    
    Throws:
    
    java.lang.IllegalArgumentException - in case of an invalid JSON String
    Since:
    
    8.5.1
  - addInitializationListener
```
public void addInitializationListener(JPack.InitializationListener listener)
```
  - removeInitializationListener
```
public void removeInitializationListener(JPack.InitializationListener listener)
```
  - getInitializationListeners
```
public JPack.InitializationListener[] getInitializationListeners()
```
  - equals
```
public boolean equals(JPack pack)
```
    Compares this pack to the specified pack. The result is true if and only if the argument is not null and is a Pack object that represents the same pack as this object.
    
    Parameters:
    pack - the pack to compare
    
    Returns:
    true if the packs are equal; false otherwise.
  - keyToString
```
public static java.lang.String keyToString(int key)
```
    Converts the given record pack key value to a string representation. This is the inverse function to buildKey(String).
    
    Parameters:
    key - record pack key value
    
    Returns:
    string representation
    Since:
    
    8.1
    
    See Also:
    buildKey(String)
  - writeExternal
```
public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
```
    Specified by:
    
    writeExternal in interface java.io.Externalizable
    
    Throws:
    
    java.io.IOException
  - readExternal
```
public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
```
    Specified by:
    
    readExternal in interface java.io.Externalizable
    
    Throws:
    
    java.io.IOException
    
    java.lang.ClassNotFoundException

www.canto.com
Canto, the Canto logo, the Cumulus logo, and Cumulus are registered trademarks of Canto GmbH, registered in the U.S. and other countries.

Class JPack

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PACK_TYPE_LIST

PACK_TYPE_RECORD

PACK_TYPE_STRING

PACK_TYPE_INT

PACK_TYPE_LONG

PACK_TYPE_SHORT

PACK_TYPE_BYTE

PACK_TYPE_BOOL

PACK_TYPE_GUID

PACK_TYPE_DOUBLE

PACK_TYPE_ALIAS

PACK_TYPE_LOCAL_CHARS

NETWORK_BYTE_ORDER

INTEL_BYTE_ORDER

NATIVE_BYTE_ORDER

Constructor Detail

JPack

JPack

JPack

Method Detail

prepareCache

countItems

getType

getDataSize

getData

getData

getIndKey

hasItem

getItemType

getItemSize

getItemData

initializeFromData

getOriginalByteOrder

newRecordPack

newListPack

getPackage

getBoolean

getByte

getShort

getShortArray

getShortArrayAt

getByteArray

getBooleanArray

getInt

getIntArray

getLong

getLongArray

getLongArrayAt

getIntArrayAt

getDoubleArrayAt

getGUIDArrayAt

getBooleanArrayAt

getByteArrayAt

getDouble

getDoubleArray

getGUID

getGUIDArray

putGUIDArray

getString

deleteItem

putItemData

putPackage

putBoolean

putByte

putShort

putInt

putIntArray

putLong

putLongArray

putBooleanArray

putByteArray

putShortArray

putDouble