Package jmri.implementation

Class FileLocationsPreferences

java.lang.Object

jmri.beans.UnboundBean

jmri.beans.Bean

jmri.util.prefs.AbstractPreferencesManager

jmri.implementation.FileLocationsPreferences

All Implemented Interfaces:

BeanInterface, PropertyChangeFirer, PropertyChangeProvider, JmriServiceProviderInterface, PreferencesManager

public class FileLocationsPreferences
extends AbstractPreferencesManager

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	SCRIPTS
static java.lang.String	USER_FILES

Fields inherited from class jmri.beans.Bean

propertyChangeSupport

Constructor Summary

Constructors

Constructor	Description
FileLocationsPreferences()

Method Summary

Modifier and Type	Method	Description
java.util.Set<java.lang.Class<? extends PreferencesManager>>	getRequires()	Get the set of PreferencesManagers that must be initialized prior to initializing this PreferencesManager.
void	initialize(Profile profile)	Initialize the PreferencesManager with preferences associated with the provided Profile.
void	savePreferences(Profile profile)	Save the preferences that this provider manages for the provided Profile.

Methods inherited from class jmri.util.prefs.AbstractPreferencesManager

addInitializationException, getInitializationExceptions, getProvides, isInitialized, isInitializedWithExceptions, isInitializing, requireAllOther, requiresNoInitializedWithExceptions, requiresNoInitializedWithExceptions, setInitialized, setInitializing

Methods inherited from class jmri.beans.Bean

addPropertyChangeListener, addPropertyChangeListener, fireIndexedPropertyChange, fireIndexedPropertyChange, fireIndexedPropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeListeners, getPropertyChangeListeners, isNotifyOnEDT, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from class jmri.beans.UnboundBean

getIndexedProperty, getProperty, getPropertyNames, hasIndexedProperty, hasProperty, setIndexedProperty, setProperty

Methods inherited from class java.lang.Object

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

Field Detail

USER_FILES

public static final java.lang.String USER_FILES

See Also:

Constant Field Values

SCRIPTS

public static final java.lang.String SCRIPTS

See Also:

Constant Field Values

Constructor Detail

FileLocationsPreferences

public FileLocationsPreferences()

Method Detail

initialize

public void initialize(Profile profile)
                throws InitializationException

Description copied from interface: PreferencesManager

Initialize the PreferencesManager with preferences associated with the provided Profile.

Implementing classes should throw an InitializationException with a user readable localized message, since it most likely be displayed to the user. Implementing classes will still want to ensure that PreferencesManager.isInitialized(jmri.profile.Profile) or PreferencesManager.isInitializedWithExceptions(jmri.profile.Profile) return true if throwing an InitializationException to ensure that the provider is not repeatedly initialized.

Parameters:

profile - the configuration profile used for this initialization; may be null to initialize for this user regardless of profile

Throws:

InitializationException - if the user needs to be notified of an issue that prevents regular use of the application

getRequires

@Nonnull
public java.util.Set<java.lang.Class<? extends PreferencesManager>> getRequires()

Description copied from class: AbstractPreferencesManager

Get the set of PreferencesManagers that must be initialized prior to initializing this PreferencesManager. It is generally preferable to require an Interface or an abstract Class instead of a concrete Class, since that allows all (or any) concrete implementations of the required class to be initialized to provide required services for the requiring PreferencesManager instance.

Note that for any set of PreferencesManagers with the same requirements, or with a circular dependency between each other, the order in which the PreferencesManagers in that set are initialized should be considered non-deterministic.

This implementation includes a default dependency on the ConnectionConfigManager.

Specified by:

getRequires in interface PreferencesManager

Overrides:

getRequires in class AbstractPreferencesManager

Returns:

An set of classes; if there are no dependencies, return an empty set instead of null; overriding implementations may add to this set directly

savePreferences

public void savePreferences(Profile profile)

Description copied from interface: PreferencesManager

Save the preferences that this provider manages for the provided Profile.

Parameters:

profile - the profile associated with the preferences to save; may be null to save preferences that apply to the current user regardless of profile