org.gnu.gconf

Class ConfClient


public class ConfClient
extends 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(String dir, ConfClientPreloadType type)
Add a directory to the list of directories the ConfClient will watch.
void
addListener(ConfClientListener listener, 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(String dir)
Check to see if a directory exists in the GConf database.
ConfValue
get(String key)
Get the value of a configuration key.
List
getAllDirs(String dir)
Get a list of the subdirectories in the provided directory.
List
getAllEntries(String dir)
Get a list of all ConfEntries in the provided direcotry.
boolean
getBoolean(String key)
Request the boolean value stored at the provided key.
ConfValue
getDefaultFromSchema(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(String key)
Request the double value stored at the provided key.
ConfEntry
getEntry(String key, String locale, boolean useSchemaDefault)
Obtain the full ConfEntry for a value.
static ConfClient
getInstance()
Method to get the default ConfClient
int
getInt(String key)
Request the int value stored at the provided key.
Object[]
getList(String key, ConfValueType listType)
Request the object array stored at the key.
ConfSchema
getSchema(String key)
Request the ConfSchema value stored at the provided key.
String
getString(String key)
Request the String value stored at the provided key.
void
notifyCallback()
void
preload(String directory, ConfClientPreloadType type)
Preload a directory.
void
removeDirectory(String dir)
Remove a directory from the list created with addDirectory.
void
removeListener(ConfClientListener listener, String nameSpace)
Removes a listener.
void
set(String key, ConfValue value)
Set the value of a configuration key.
boolean
setBoolean(String key, boolean value)
Change the value stored at the provided key to the provided boolean value.
boolean
setDouble(String key, double value)
Change the value stored at the provided key to the provided double value.
boolean
setInt(String key, int value)
Change the value stored at the provided key to the provided int value.
boolean
setList(String key, ConfValueType listType, List value)
boolean
setSchema(String key, ConfSchema value)
Change the value stored at the provided key to the provided ConfSchema value.
boolean
setString(String key, 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(String key)
Unsets the value of the provided key.

Method Details

addDirectory

public void addDirectory(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 -

addListener

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

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.

dirExists

public boolean dirExists(String dir)
            throws ConfException
Check to see if a directory exists in the GConf database.
Parameters:
dir -
Throws:
ConfException -

get

public ConfValue get(String key)
            throws ConfException
Get the value of a configuration key.
Parameters:
key -
Throws:
ConfException -

getAllDirs

public List getAllDirs(String dir)
            throws ConfException
Get a list of the subdirectories in the provided directory.
Parameters:
dir -
Throws:
ConfException -

getAllEntries

public List getAllEntries(String dir)
            throws ConfException
Get a list of all ConfEntries in the provided direcotry.
Parameters:
dir -
Throws:
ConfException -

getBoolean

public boolean getBoolean(String key)
            throws ConfException
Request the boolean value stored at the provided key.
Parameters:
key -
Throws:
ConfException -

getDefaultFromSchema

public ConfValue getDefaultFromSchema(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 -

getDouble

public double getDouble(String key)
            throws ConfException
Request the double value stored at the provided key.
Parameters:
key -
Throws:
ConfException -

getEntry

public ConfEntry getEntry(String key,
                          String locale,
                          boolean useSchemaDefault)
            throws ConfException
Obtain the full ConfEntry for a value.
Parameters:
key -
locale -
useSchemaDefault -
Throws:
ConfException -

getInstance

public static ConfClient getInstance()
Method to get the default ConfClient
Returns:
The default ConfClient.

getInt

public int getInt(String key)
            throws ConfException
Request the int value stored at the provided key.
Parameters:
key -
Throws:
ConfException -

getList

public Object[] getList(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 -

getSchema

public ConfSchema getSchema(String key)
            throws ConfException
Request the ConfSchema value stored at the provided key.
Parameters:
key -
Throws:
ConfException -

getString

public String getString(String key)
            throws ConfException
Request the String value stored at the provided key.
Parameters:
key -
Throws:
ConfException -

notifyCallback

public void notifyCallback()

preload

public void preload(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 -

removeDirectory

public void removeDirectory(String dir)
            throws ConfException
Remove a directory from the list created with addDirectory.
Parameters:
dir -
Throws:
ConfException -

removeListener

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

set

public void set(String key,
                ConfValue value)
            throws ConfException
Set the value of a configuration key.
Parameters:
key -
value -
Throws:
ConfException -

setBoolean

public boolean setBoolean(String key,
                          boolean value)
            throws ConfException
Change the value stored at the provided key to the provided boolean value.
Parameters:
key -
value -
Throws:
ConfException -

setDouble

public boolean setDouble(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(String key,
                      int value)
            throws ConfException
Change the value stored at the provided key to the provided int value.
Parameters:
key -
value -
Throws:
ConfException -

setList

public boolean setList(String key,
                       ConfValueType listType,
                       List value)
            throws ConfException

setSchema

public boolean setSchema(String key,
                         ConfSchema value)
            throws ConfException
Change the value stored at the provided key to the provided ConfSchema value.
Parameters:
key -
value -
Throws:
ConfException -

setString

public boolean setString(String key,
                         String value)
            throws ConfException
Change the value stored at the provided key to the provided String value.
Parameters:
key -
value -
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 -

t

public void t()

unset

public boolean unset(String key)
            throws ConfException
Unsets the value of the provided key.
Parameters:
key -
Throws:
ConfException -