org.mdiutil.prefs

Class FilePreferencesFactory

java.lang.Object

org.mdiutil.prefs.FilePreferencesFactory

All Implemented Interfaces:

PreferencesFactory

public class FilePreferencesFactory
extends Object
implements PreferencesFactory

A simple factory object that generates network Preferences objects, backed in a simple File in the File System. These preferences have the following properties :

• the user preferences are serialized in an xml file, under a directory specific of the application
• there are no system preferences

The effective backing stores will only be created after the invocation of systemRoot() or userRoot()

For a user preference:

• the backing store will be : <userDir>/subDir/.<appli>/pref.xml
• if userDir is null : <userDir> = user.home
• if subDir is null : subDir = ""

Constructor Summary

Constructors

Constructor and Description
FilePreferencesFactory(File userFile)

Method Summary

Modifier and Type	Method and Description
File	getFile() Return the File used for the factory.
Preferences	systemRoot() Always return null.
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() A 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

Constructor Detail

FilePreferencesFactory

public FilePreferencesFactory(File userFile)

Method Detail

getFile

public File getFile()

Return the File used for the factory.

Returns:

the File

systemRoot

public Preferences systemRoot()

Always return null.

Specified by:

systemRoot in interface PreferencesFactory

Returns:

null

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 "." <application 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 user root preference node

userRootAsNetwork

public NetworkPreferences userRootAsNetwork()

A Convenience method that return the same object as userRoot().

Returns:

the userRoot