rs.baselib.prefs

Interface IPreferencesService

All Known Implementing Classes:

AbstractPreferencesService, PreferencesService

public interface IPreferencesService

The preference service.

Author:

ralph

Method Summary

Methods

Modifier and Type	Method and Description
void	flush(IPreferences node) Flushes any changes made in this node.
Lock	getReadLock(IPreferences node) Returns the read lock object for the given node.
IPreferences	getSystemPreferences(String applicationName) Returns the system preferences for the given application.
File	getSystemPreferencesHome(String applicationName) Returns the home directory for system preferences of the given application.
IPreferences	getUserPreferences(String applicationName) Returns the user preferences for the given application.
File	getUserPreferencesHome(String applicationName) Returns the home directory for user preferences of the given application.
Lock	getWriteLock(IPreferences node) Returns the write lock object for the given node.
void	sync(IPreferences node) Wait for any modifications to be flushed.

Method Detail

getUserPreferences

IPreferences getUserPreferences(String applicationName)
                                throws BackingStoreException

Returns the user preferences for the given application.

Parameters:

applicationName - name of application

Throws:

BackingStoreException

getSystemPreferences

IPreferences getSystemPreferences(String applicationName)
                                  throws BackingStoreException

Returns the system preferences for the given application.

Parameters:

applicationName - name of application

Throws:

BackingStoreException

flush

void flush(IPreferences node)
           throws BackingStoreException

Flushes any changes made in this node. The method does not return before the flush has been completed.

Parameters:

node - the node to be flushed

Throws:

BackingStoreException - when there has been a communication problem with the backing store.

sync

void sync(IPreferences node)
          throws BackingStoreException

Wait for any modifications to be flushed. The method does not return before the next flush has been completed (in case modifications are pending).

Parameters:

node - the node to be flushed

Throws:

BackingStoreException - when there has been a communication problem with the backing store.

getReadLock

Lock getReadLock(IPreferences node)

Returns the read lock object for the given node.

Parameters:

node - the node that requires a read lock

Returns:

the responsible Lock object

getWriteLock

Lock getWriteLock(IPreferences node)

Returns the write lock object for the given node.

Parameters:

node - the node that requires a write lock

Returns:

the responsible Lock object

getUserPreferencesHome

File getUserPreferencesHome(String applicationName)

Returns the home directory for user preferences of the given application.

Parameters:

applicationName - name of application

Returns:

user preferences home

getSystemPreferencesHome

File getSystemPreferencesHome(String applicationName)

Returns the home directory for system preferences of the given application.

Parameters:

applicationName - name of application

Returns:

system preferences home