com.syncbuilder.storage
Class Pref

java.lang.Object
  |
  +--com.syncbuilder.storage.Block
        |
        +--com.syncbuilder.storage.Pref

Direct Known Subclasses:

Pref, Pref, SignaturePref, SyncPref

public abstract class Pref

extends Block

A representation of a preference-object on the Palm device.
Each preference is uniquely identified by the Creator ID of the application to which it belongs, and an ID number. It also has a version number, but this is not used for identification. The contents of a pref are formatted bytes, with a layout that is native to the application.

If you are subclassing the Pref class, then make sure that all subclasses will always know their Creator ID!

See Also:

Serialized Form

Field Summary

boolean	backed_up If set, use 'Saved Preferences' database
Char4	creator The creator ID of the application which uses this Pref
int	id The ID number of the Pref
int	version The version number of the Pref

Fields inherited from class com.syncbuilder.storage.Block

raw

Constructor Summary

Pref(byte[] contents, Char4 creator, int id, int version, boolean backed_up)
Create a fully initialized Pref-object.

Method Summary

java.lang.String

describe() Returns information about this Pref object as a formatted String.

Methods inherited from class com.syncbuilder.storage.Block

fill, pack, toString, unpack

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

creator

public Char4 creator

The creator ID of the application which uses this Pref

id

public int id

The ID number of the Pref

version

public int version

The version number of the Pref

backed_up

public boolean backed_up

If set, use 'Saved Preferences' database

Constructor Detail

Pref

public Pref(byte[] contents,
            Char4 creator,
            int id,
            int version,
            boolean backed_up)
     throws NoCreatorException

Create a fully initialized Pref-object.

Method Detail

describe

public java.lang.String describe()

Returns information about this Pref object as a formatted String.

Returns:

a String representation of this Pref object.

Overrides:

describe in class Block