org.mdiutil.prefs

Class MemoryPreferencesFactory

java.lang.Object

org.mdiutil.prefs.MemoryPreferencesFactory

All Implemented Interfaces:

PreferencesFactory

public class MemoryPreferencesFactory
extends Object
implements PreferencesFactory

A factory object that generates "in memory" Preferences objects.

Since:

0.4

Method Summary

Modifier and Type	Method and Description
String	getApplicationName() get the name that tag the factory for the application.
static MemoryPreferencesFactory	getFactory() get the uniquely defined factory.
static MemoryPreferencesFactory	newFactory(String subDir, String appli) Create the NetworkPreferencesFactory.
Preferences	systemRoot() Returns the system root preference node.
NetworkPreferences	systemRootAsNetwork() convenience method that return the same object as systemRoot().
Preferences	userRoot() Returns the user root preference node corresponding to the calling user (Multiple calls on this method will return the same object reference).
NetworkPreferences	userRootAsNetwork() convenience method that return the same object as userRoot().

Methods inherited from class java.lang.Object

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

Method Detail

newFactory

public static MemoryPreferencesFactory newFactory(String subDir,
                                                  String appli)
                                           throws BackingStoreException

Create the NetworkPreferencesFactory.

Parameters:

subDir - the sub-directory of userDir or systemDir, under which to create the application preferences file (if null, there will be no sub-directory definition)

appli - the name that will tag the factory to create. This name is useful for the user root creation, as the user preferences are serialized in an xml file in the user.home directory, under a directory construted with the name of the application

Throws:

BackingStoreException - if the factory have already been created, or if the userDir or systemDir are not null and are not valid or are not already existing

getFactory

public static MemoryPreferencesFactory getFactory()

get the uniquely defined factory.

getApplicationName

public String getApplicationName()

get the name that tag the factory for the application.

systemRoot

public Preferences systemRoot()

Returns the system root preference node. (Multiple calls on this method will return the same object reference).

The backing store of the user preferences will be a file in a directory with the following name ".prefs", in the user.dir directory

Specified by:

systemRoot in interface PreferencesFactory

Returns:

the system root (the returned Preferences object is a NetworkPreferences

systemRootAsNetwork

public NetworkPreferences systemRootAsNetwork()

convenience method that return the same object as systemRoot().

userRoot

public Preferences userRoot()

Returns the user root preference node corresponding to the calling user (Multiple calls on this method will return the same object reference).

The backing store of the user preferences will be a file in a directory with the following name "." , in the user.home directory. The application name is the name wich has been defined at the creation of the factory.

Specified by:

userRoot in interface PreferencesFactory

Returns:

the system root (the returned Preferences object is a NetworkPreferences

userRootAsNetwork

public NetworkPreferences userRootAsNetwork()

convenience method that return the same object as userRoot().