Package jmri.util.prefs
This package provides two mechanisms for storing preferences and one
mechanism for storing user interface state within a JMRI profile:
JmriConfigurationProvider
- Complex preferences within an XML element provided by the object storing and retrieving the element.
JmriPreferencesProvider
- Simple preferences within a
Preferences
construct. JmriUserInterfaceConfigurationProvider
- Complex user interface state within an XML element provided by the object storing and retrieving the element.
The public interfaces of these classes requires that a
Profile
be passed so that these are ready to (even
though nothing currently uses this capability) handle multiple profiles, or
non-profile-specific preferences or state.
Note the above implies that it is critical that no method
in any class in this package refer to the results of
ProfileManager.getActiveProfile()
.
-
Class Summary Class Description AbstractConfigurationProvider AbstractPreferencesManager An abstract PreferencesManager that implements some of the boilerplate that PreferencesManager implementations would otherwise require.JmriConfiguration JmriConfigurationProvider Provides a general purpose XML element storage mechanism for the storage of configuration and preferences too complex to be handled byJmriPreferencesProvider
.JmriPreferencesActionFactory This class provides a method to create an action that launches preferences.JmriPreferencesProvider Provides instances ofPreferences
backed by a JMRI-specific storage implementation based on a Properties file.JmriUserInterfaceConfigurationProvider Provides a general purpose XML element storage mechanism for the storage of user interface configuration. -
Exception Summary Exception Description HasConnectionButUnableToConnectException An exception thrown then there is a configured connection, but JMRI is unable to open that connection.InitializationException This exception represents an exception thrown while attempting to initialize a PreferencesProvider.