org.mdi.bootstrap

Interface Configuration

All Known Subinterfaces:

Configuration2

All Known Implementing Classes:

AbstractConfiguration2

public interface Configuration

This interface defines the minimal common behaviour of all configurations. All Plugins configurations that must be serialized (that means that they are stored after quitting and retrieved when opening) must extend this class.

See Also:

Plugin.getPluginConfiguration()

Method Summary

Modifier and Type	Method and Description
void	getConfiguration(java.util.prefs.Preferences pref, java.io.File dir) Called when the Preferences key-value entries must be updated with the configuration.
void	putConfiguration(java.util.prefs.Preferences pref, java.io.File dir) Called when the configuration must be filled with key-value entries stored in a Preferences.
default void	setupApplicationDesc(ApplicationDesc appDesc) Setup the application description.

Method Detail

putConfiguration

void putConfiguration(java.util.prefs.Preferences pref,
                      java.io.File dir)

Called when the configuration must be filled with key-value entries stored in a Preferences.

Parameters:

pref - the Preferences

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

getConfiguration

void getConfiguration(java.util.prefs.Preferences pref,
                      java.io.File dir)

Called when the Preferences key-value entries must be updated with the configuration.

Parameters:

pref - the Preferences

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

setupApplicationDesc

default void setupApplicationDesc(ApplicationDesc appDesc)

Setup the application description. Do nothing by default.

Parameters:

appDesc - the application description