NetworkPreferencesFactory

java.lang.Object
- org.mdiutil.prefs.NetworkPreferencesFactory

All Implemented Interfaces:

PreferencesFactory
```
public class NetworkPreferencesFactory
extends Object
implements PreferencesFactory
```
A factory object that generates network Preferences objects. These preferences have the following properties :
- the user preferences are serialized in an xml file, under a directory specific of the application
- the system preferences are serialized in an xml file in the user.dir directory
This ensures that the preferences will follow a "nomad" user.
A NetworkPreferencesFactory is unique and have the following characteristics :
- a user directory root, under which all user NetworkPreferences must be stored. If the corresponding file is null, the user.home directory will be used
- a system directory root, under which all system NetworkPreferences must be stored. If the corresponding file is null, the system.home directory will be used
- an sub-directory under which to put the specific application system and user direcrories
- the application name
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 = ""
For a system preference :
- the backing store will be : <systemDir>/subDir/pref.xml
- if systemDir is null, the backing store will be : user.dir/pref.xml
- if subDir is null : subDir = ""
Examples:
- for NetworkPreferencesFactory(null, null, null, "test") :
  - user preferences backing store : user.home/.test/pref.xml
  - system preferences backing store : user.dir/pref.xml
- for NetworkPreferencesFactory(new File("c:/user"), new File("c:/system"), "subDir", "test") :
  - user preferences backing store : c:/user/subDir/.test/pref.xml
  - system preferences backing store : c:/system/subDir/.test/pref.xml
- for NetworkPreferencesFactory(null, null, "subDir", "test") :
  - user preferences backing store : user.home/subDir/.test/pref.xml
  - system preferences backing store : user.dir/pref.xml

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getApplicationName()` Return the name that tag the factory for the application.
`static NetworkPreferencesFactory`	`getFactory()` Return the uniquely defined factory.
`File`	`getSystemDirectory()` Return the system root directory.
`File`	`getUserDirectory()` Return the user root directory.
`static NetworkPreferencesFactory`	`newFactory(File userDir, File systemDir, String subDir, String appli)` Create the factory.
`static void`	`reset()` Reset the factory.
`static Preferences`	`systemNodeForPackage(Class<?> c)`
`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 NetworkPreferencesFactory newFactory(File userDir,
                                                   File systemDir,
                                                   String subDir,
                                                   String appli)
                                            throws BackingStoreException
```
    Create the factory.
    
    Parameters:
    
    userDir - the root directory under which will be stored the user preferences (null if it is the user.home directory)
    
    systemDir - the root directory under which will be stored the system preferences (null if it is the user.dir directory)
    
    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
    
    Returns:
    
    the NetworkPreferencesFactory
    
    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
  - reset
```
public static void reset()
```
    Reset the factory. This will set the internally defined getFactory() to null.
  - getFactory
```
public static NetworkPreferencesFactory getFactory()
```
    Return the uniquely defined factory.
    
    Returns:
    
    the uniquely defined factory
  - getApplicationName
```
public String getApplicationName()
```
    Return the name that tag the factory for the application.
    
    Returns:
    
    the name that tag the factory for the application
  - getSystemDirectory
```
public File getSystemDirectory()
```
    Return the system root directory.
    
    Returns:
    
    the system root directory
  - getUserDirectory
```
public File getUserDirectory()
```
    Return the user root directory.
    
    Returns:
    
    the user root directory
  - 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
  - systemNodeForPackage
```
public static Preferences systemNodeForPackage(Class<?> c)
```
  - systemRootAsNetwork
```
public NetworkPreferences systemRootAsNetwork()
```
    Convenience method that return the same object as systemRoot().
    
    Returns:
    
    the System root
  - 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 system root (the returned Preferences object is a NetworkPreferences
  - userRootAsNetwork
```
public NetworkPreferences userRootAsNetwork()
```
    Convenience method that return the same object as userRoot().
    
    Returns:
    
    the user root

Class NetworkPreferencesFactory

Method Summary

Methods inherited from class java.lang.Object

Method Detail

newFactory

reset

getFactory

getApplicationName

getSystemDirectory

getUserDirectory

systemRoot

systemNodeForPackage

systemRootAsNetwork

userRoot

userRootAsNetwork