org.gnu.gconf
Class ConfClient

java.lang.Object
  extended by org.gnu.glib.Struct
      extended by org.gnu.glib.GObject
          extended by org.gnu.gconf.ConfClient

public class ConfClient
extends org.gnu.glib.GObject

ConfClient provides a client-side cache for a specified list of directories your're interested in. You can preload entire directories into cache to enhance performance. It also provides events when a value changes.


Method Summary
 void addDirectory(java.lang.String dir, ConfClientPreloadType type)
          Add a directory to the list of directories the ConfClient will watch.
 void addListener(ConfClientListener listener, java.lang.String nameSpace)
          Register an object to handle notify events.
 void clearCache()
          If you know you're done reading values for a while you can blow away the cache.
 boolean dirExists(java.lang.String dir)
          Check to see if a directory exists in the GConf database.
 ConfValue get(java.lang.String key)
          Get the value of a configuration key.
 java.util.List getAllDirs(java.lang.String dir)
          Get a list of the subdirectories in the provided directory.
 java.util.List getAllEntries(java.lang.String dir)
          Get a list of all ConfEntries in the provided direcotry.
 boolean getBoolean(java.lang.String key)
          Request the boolean value stored at the provided key.
 ConfValue getDefaultFromSchema(java.lang.String key)
          Return the default value stored in the key's schema, if the key has a schema associated and the schema exists and the schema contains a default value.
 double getDouble(java.lang.String key)
          Request the double value stored at the provided key.
 ConfEntry getEntry(java.lang.String key, java.lang.String locale, boolean useSchemaDefault)
          Obtain the full ConfEntry for a value.
static ConfClient getInstance()
          Method to get the default ConfClient
 int getInt(java.lang.String key)
          Request the int value stored at the provided key.
 java.lang.Object[] getList(java.lang.String key, ConfValueType listType)
          Request the object array stored at the key.
 ConfSchema getSchema(java.lang.String key)
          Request the ConfSchema value stored at the provided key.
 java.lang.String getString(java.lang.String key)
          Request the String value stored at the provided key.
 void notifyCallback()
           
 void preload(java.lang.String directory, ConfClientPreloadType type)
          Preload a directory.
 void removeDirectory(java.lang.String dir)
          Remove a directory from the list created with addDirectory.
 void removeListener(ConfClientListener listener, java.lang.String nameSpace)
          Removes a listener.
 void set(java.lang.String key, ConfValue value)
          Set the value of a configuration key.
 boolean setBoolean(java.lang.String key, boolean value)
          Change the value stored at the provided key to the provided boolean value.
 boolean setDouble(java.lang.String key, double value)
          Change the value stored at the provided key to the provided double value.
 boolean setInt(java.lang.String key, int value)
          Change the value stored at the provided key to the provided int value.
 boolean setList(java.lang.String key, ConfValueType listType, java.util.List value)
           
 boolean setSchema(java.lang.String key, ConfSchema value)
          Change the value stored at the provided key to the provided ConfSchema value.
 boolean setString(java.lang.String key, java.lang.String value)
          Change the value stored at the provided key to the provided String value.
 void suggestSync()
          Suggest to gconfd that you've just finished a block of changes and it would be an optimal time to sync to permanent storage.
 void t()
           
 boolean unset(java.lang.String key)
          Unsets the value of the provided key.
 
Methods inherited from class org.gnu.glib.GObject
addEventHandler, addEventHandler, addEventHandler, addEventHandler, addEventHandler, addEventHandler, addEventHandler, addListener, collect, freezeNotify, getBooleanProperty, getData, getDoubleProperty, getEventListenerClass, getEventType, getFloatProperty, getGObjectFromHandle, getIntProperty, getJavaObjectProperty, getLongProperty, getPixbufProperty, getProperty, getStringProperty, hasProperty, notify, removeEventHandler, removeListener, setBooleanProperty, setData, setDoubleProperty, setFloatProperty, setIntProperty, setJavaObjectProperty, setLongProperty, setPixbufProperty, setProperty, setStringProperty, thawNotify
 
Methods inherited from class org.gnu.glib.Struct
equals, getHandle, getNullHandle, hashCode
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getInstance

public static ConfClient getInstance()
Method to get the default ConfClient

Returns:
The default ConfClient.

addDirectory

public void addDirectory(java.lang.String dir,
                         ConfClientPreloadType type)
                  throws ConfException
Add a directory to the list of directories the ConfClient will watch. Any changes to keys below this directory will cause the "value_changed" event to be fired.

Parameters:
dir -
type -
Throws:
ConfException

removeDirectory

public void removeDirectory(java.lang.String dir)
                     throws ConfException
Remove a directory from the list created with addDirectory.

Parameters:
dir -
Throws:
ConfException

addListener

public void addListener(ConfClientListener listener,
                        java.lang.String nameSpace)
                 throws ConfException
Register an object to handle notify events.

Throws:
ConfException
See Also:
ConfClientListener

removeListener

public void removeListener(ConfClientListener listener,
                           java.lang.String nameSpace)
Removes a listener.

See Also:
addListener(ConfClientListener, String)

clearCache

public void clearCache()
If you know you're done reading values for a while you can blow away the cache. Note that this nullifies the effect of any preloading you may have done. However it frees some memory.


preload

public void preload(java.lang.String directory,
                    ConfClientPreloadType type)
             throws ConfException
Preload a directory. The directory must have been added already. This is only useful as an optimization if you clear the cache, then later want to do a lot a reads again.

Parameters:
directory - The directory to load
type - How to preload the directory.
Throws:
ConfException

set

public void set(java.lang.String key,
                ConfValue value)
         throws ConfException
Set the value of a configuration key.

Parameters:
key -
value -
Throws:
ConfException

get

public ConfValue get(java.lang.String key)
              throws ConfException
Get the value of a configuration key.

Parameters:
key -
Throws:
ConfException

getEntry

public ConfEntry getEntry(java.lang.String key,
                          java.lang.String locale,
                          boolean useSchemaDefault)
                   throws ConfException
Obtain the full ConfEntry for a value.

Parameters:
key -
locale -
useSchemaDefault -
Throws:
ConfException

getDefaultFromSchema

public ConfValue getDefaultFromSchema(java.lang.String key)
                               throws ConfException
Return the default value stored in the key's schema, if the key has a schema associated and the schema exists and the schema contains a default value.

Parameters:
key -
Throws:
ConfException

unset

public boolean unset(java.lang.String key)
              throws ConfException
Unsets the value of the provided key.

Parameters:
key -
Throws:
ConfException

getAllEntries

public java.util.List getAllEntries(java.lang.String dir)
                             throws ConfException
Get a list of all ConfEntries in the provided direcotry.

Parameters:
dir -
Throws:
ConfException

getAllDirs

public java.util.List getAllDirs(java.lang.String dir)
                          throws ConfException
Get a list of the subdirectories in the provided directory.

Parameters:
dir -
Throws:
ConfException

suggestSync

public void suggestSync()
                 throws ConfException
Suggest to gconfd that you've just finished a block of changes and it would be an optimal time to sync to permanent storage.

Throws:
ConfException

dirExists

public boolean dirExists(java.lang.String dir)
                  throws ConfException
Check to see if a directory exists in the GConf database.

Parameters:
dir -
Throws:
ConfException

getDouble

public double getDouble(java.lang.String key)
                 throws ConfException
Request the double value stored at the provided key.

Parameters:
key -
Throws:
ConfException

getInt

public int getInt(java.lang.String key)
           throws ConfException
Request the int value stored at the provided key.

Parameters:
key -
Throws:
ConfException

getString

public java.lang.String getString(java.lang.String key)
                           throws ConfException
Request the String value stored at the provided key.

Parameters:
key -
Throws:
ConfException

getBoolean

public boolean getBoolean(java.lang.String key)
                   throws ConfException
Request the boolean value stored at the provided key.

Parameters:
key -
Throws:
ConfException

getSchema

public ConfSchema getSchema(java.lang.String key)
                     throws ConfException
Request the ConfSchema value stored at the provided key.

Parameters:
key -
Throws:
ConfException

getList

public java.lang.Object[] getList(java.lang.String key,
                                  ConfValueType listType)
                           throws ConfException
Request the object array stored at the key. The return object array is of the type provided.

Parameters:
key -
listType -
Throws:
ConfException

setDouble

public boolean setDouble(java.lang.String key,
                         double value)
                  throws ConfException
Change the value stored at the provided key to the provided double value.

Parameters:
key -
value -
Throws:
ConfException

setInt

public boolean setInt(java.lang.String key,
                      int value)
               throws ConfException
Change the value stored at the provided key to the provided int value.

Parameters:
key -
value -
Throws:
ConfException

setString

public boolean setString(java.lang.String key,
                         java.lang.String value)
                  throws ConfException
Change the value stored at the provided key to the provided String value.

Parameters:
key -
value -
Throws:
ConfException

setBoolean

public boolean setBoolean(java.lang.String key,
                          boolean value)
                   throws ConfException
Change the value stored at the provided key to the provided boolean value.

Parameters:
key -
value -
Throws:
ConfException

setSchema

public boolean setSchema(java.lang.String key,
                         ConfSchema value)
                  throws ConfException
Change the value stored at the provided key to the provided ConfSchema value.

Parameters:
key -
value -
Throws:
ConfException

setList

public boolean setList(java.lang.String key,
                       ConfValueType listType,
                       java.util.List value)
                throws ConfException
Throws:
ConfException

notifyCallback

public void notifyCallback()

t

public void t()