org.mdi.app

Class ConfigurationManager

java.lang.Object

org.mdi.app.ConfigurationManager

public class ConfigurationManager
extends java.lang.Object

This class is responsible of serializing (when quitting), and deserializing (when opening) the application configuration. The elements that are serialized / deserialized are:

• the main Configuration
• each Plugin Configuration, if it exist

Constructor Summary

Constructors

Constructor and Description
ConfigurationManager(java.util.List<Plugin> plugins, java.util.prefs.Preferences prefRoot, Configuration conf)

Method Summary

Modifier and Type	Method and Description
void	deserializeConfiguration() Return the previously serialized configuration, and deserialize it for the application and the Plugins.
void	deserializeConfiguration(java.io.File dir) Return the previously serialized configuration, and deserialize it it for the application and the Plugins.
void	deserializeConfiguration(java.util.prefs.Preferences root) Return the previously serialized configuration, and deserialize it for the application and the Plugins in a user-defined Preferences root.
void	deserializeConfiguration(java.util.prefs.Preferences root, java.io.File dir) Return the previously serialized configuration, and deserialize it for the application and the Plugins in a user-defined Preferences root.
void	deserializeMainConfiguration() Return the previously serialized configuration, and deserialize it for the application.
void	deserializeMainConfiguration(java.io.File dir) Return the previously serialized configuration, and deserialize it for the application.
void	deserializeMainConfiguration(java.util.prefs.Preferences root) Return the previously serialized configuration, and deserialize it for the application in a user-defined Preferences root.
void	deserializeMainConfiguration(java.util.prefs.Preferences root, java.io.File dir) Return the previously serialized configuration, and deserialize it for the application in a user-defined Preferences root.
void	deserializePluginsConfiguration(java.util.List<Plugin> plugins) Return the previously serialized configuration for Plugins, and deserialize it.
void	deserializePluginsConfiguration(java.util.List<Plugin> plugins, java.util.prefs.Preferences root) Return the previously serialized configuration for Plugins, and deserialize it in a user-defined Preferences root.
void	deserializePluginsConfiguration(java.util.List<Plugin> plugins, java.util.prefs.Preferences root, java.io.File dir) Return the previously serialized configuration for Plugins, and deserialize it in a user-defined Preferences root.
java.util.prefs.Preferences	getPreferencesRoot() Return the Preferences root.
void	serializeConfiguration(java.util.List<Plugin> plugins) Serialize the configuration in a user-defined root, using a null directory as the default for the serialization.
void	serializeConfiguration(java.util.List<Plugin> plugins, java.io.File dir) Serialize the configuration in a user-defined root.
void	serializeConfiguration(java.util.List<Plugin> plugins, java.util.prefs.Preferences root) Serialize the configuration, using a null directory as the default for the serialization.
void	serializeConfiguration(java.util.List<Plugin> plugins, java.util.prefs.Preferences root, java.io.File dir) Serialize the configuration, using a directory as the default for the serialization.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationManager

public ConfigurationManager(java.util.List<Plugin> plugins,
                            java.util.prefs.Preferences prefRoot,
                            Configuration conf)

Method Detail

getPreferencesRoot

public java.util.prefs.Preferences getPreferencesRoot()

Return the Preferences root.

Returns:

the Preferences root

deserializeConfiguration

public void deserializeConfiguration(java.io.File dir)

Return the previously serialized configuration, and deserialize it it for the application and the Plugins. This deserialization will update:

• the main application configuration: see Configuration
• each existing Plugin configuration

Parameters:

dir - the reference directory for the configuration. If the directory is null, the default one will be used

deserializeConfiguration

public void deserializeConfiguration()

Return the previously serialized configuration, and deserialize it for the application and the Plugins. This deserialization will update :

• the main application configuration: see Configuration
• each existing Plugin configuration

deserializeConfiguration

public void deserializeConfiguration(java.util.prefs.Preferences root,
                                     java.io.File dir)

Return the previously serialized configuration, and deserialize it for the application and the Plugins in a user-defined Preferences root.

Parameters:

root - the preferences root

dir - the directory to use as a current directory to store File preferences. This parameter can be used for the configuration to define the File preference path relative to the directory, but a Configuration might also not take this parameter into account at all

See Also:

deserializeMainConfiguration()

deserializeConfiguration

public void deserializeConfiguration(java.util.prefs.Preferences root)

Return the previously serialized configuration, and deserialize it for the application and the Plugins in a user-defined Preferences root.

Parameters:

root - the preferences root

See Also:

deserializeMainConfiguration()

deserializeMainConfiguration

public void deserializeMainConfiguration(java.io.File dir)

Return the previously serialized configuration, and deserialize it for the application.

This deserialization will update:

• the main application configuration: see Configuration

Parameters:

dir - the reference directory for the configuration. If the directory is null, the default one will be used

deserializeMainConfiguration

public void deserializeMainConfiguration()

Return the previously serialized configuration, and deserialize it for the application.

This deserialization will update:

• the main application configuration : see Configuration

deserializeMainConfiguration

public void deserializeMainConfiguration(java.util.prefs.Preferences root,
                                         java.io.File dir)

Return the previously serialized configuration, and deserialize it for the application in a user-defined Preferences root.

Parameters:

root - the preferences root

dir - the directory to use as a current directory to store File preferences. This parameter can be used for the configuration to define the File preference path relative to the directory, but a Configuration might also not take this parameter into account at all

See Also:

deserializeMainConfiguration()

deserializeMainConfiguration

public void deserializeMainConfiguration(java.util.prefs.Preferences root)

Return the previously serialized configuration, and deserialize it for the application in a user-defined Preferences root.

Parameters:

root - the preferences root

See Also:

deserializeMainConfiguration()

deserializePluginsConfiguration

public void deserializePluginsConfiguration(java.util.List<Plugin> plugins)

Return the previously serialized configuration for Plugins, and deserialize it.

This deserialization will update :

• the main application configuration: see Configuration
• each existing Plugin configuration: see Configuration

Parameters:

plugins - the list of Plugins

deserializePluginsConfiguration

public void deserializePluginsConfiguration(java.util.List<Plugin> plugins,
                                            java.util.prefs.Preferences root,
                                            java.io.File dir)

Return the previously serialized configuration for Plugins, and deserialize it in a user-defined Preferences root.

Parameters:

plugins - the list of Plugins

root - the preferences root

dir - the reference directory for the deserialization

See Also:

deserializePluginsConfiguration(java.util.List)

deserializePluginsConfiguration

public void deserializePluginsConfiguration(java.util.List<Plugin> plugins,
                                            java.util.prefs.Preferences root)

Return the previously serialized configuration for Plugins, and deserialize it in a user-defined Preferences root.

Parameters:

plugins - the list of Plugins

root - the preferences root

serializeConfiguration

public void serializeConfiguration(java.util.List<Plugin> plugins,
                                   java.io.File dir)
                            throws java.util.prefs.BackingStoreException

Serialize the configuration in a user-defined root.

This serialization will use the state of :

• the main application configuration : see Configuration
• each existing Plugin configuration : see Configuration

Parameters:

plugins - the list of Plugins

dir - the reference directory for the serialization

Throws:

java.util.prefs.BackingStoreException - if the serialization could not be performed

serializeConfiguration

public void serializeConfiguration(java.util.List<Plugin> plugins)
                            throws java.util.prefs.BackingStoreException

Serialize the configuration in a user-defined root, using a null directory as the default for the serialization.

Parameters:

plugins - the list of Plugins

Throws:

java.util.prefs.BackingStoreException - if the serialization could not be performed

See Also:

serializeConfiguration(java.util.List, java.util.prefs.Preferences, java.io.File)

serializeConfiguration

public void serializeConfiguration(java.util.List<Plugin> plugins,
                                   java.util.prefs.Preferences root,
                                   java.io.File dir)
                            throws java.util.prefs.BackingStoreException

Serialize the configuration, using a directory as the default for the serialization.

This serialization will use the state of :

• the main application configuration : see Configuration
• each existing Plugin configuration : see Configuration

Parameters:

plugins - the list of Plugins

dir - the reference directory for the serialization

root - the Preferences root

Throws:

java.util.prefs.BackingStoreException - if the serialization could not be performed

serializeConfiguration

public void serializeConfiguration(java.util.List<Plugin> plugins,
                                   java.util.prefs.Preferences root)
                            throws java.util.prefs.BackingStoreException

Serialize the configuration, using a null directory as the default for the serialization.

Parameters:

plugins - the list of Plugins

root - the Preferences root

Throws:

java.util.prefs.BackingStoreException - if the serialization could not be performed

See Also:

serializeConfiguration(java.util.List, java.util.prefs.Preferences, java.io.File)