Changeset 12881 in josm for trunk/src/org/openstreetmap/josm/data/Preferences.java

Timestamp:

2017-09-21T12:41:32+02:00 (7 years ago)

Author:

bastiK

Message:

see #15229 - move remaining classes to spi.preferences package, to make it self-contained

• extract event listener classes from Preferences (duplicated, for smooth transition)
• move *Setting classes

File:

• trunk/src/org/openstreetmap/josm/data/Preferences.java (modified) (11 diffs)

trunk/src/org/openstreetmap/josm/data/Preferences.java

@@ -48 +48 @@
 import org.openstreetmap.josm.data.preferences.DoubleProperty;
 import org.openstreetmap.josm.data.preferences.IntegerProperty;
-import org.openstreetmap.josm.data.preferences.ListListSetting;
-import org.openstreetmap.josm.data.preferences.ListSetting;
+import org.openstreetmap.josm.spi.preferences.ListListSetting;
+import org.openstreetmap.josm.spi.preferences.ListSetting;
 import org.openstreetmap.josm.data.preferences.LongProperty;
-import org.openstreetmap.josm.data.preferences.MapListSetting;
+import org.openstreetmap.josm.spi.preferences.MapListSetting;
 import org.openstreetmap.josm.data.preferences.PreferencesReader;
 import org.openstreetmap.josm.data.preferences.PreferencesWriter;
-import org.openstreetmap.josm.data.preferences.Setting;
-import org.openstreetmap.josm.data.preferences.StringSetting;
+import org.openstreetmap.josm.spi.preferences.Setting;
+import org.openstreetmap.josm.spi.preferences.StringSetting;
 import org.openstreetmap.josm.data.preferences.sources.ExtendedSourceEntry;
 import org.openstreetmap.josm.data.preferences.sources.ValidatorPrefHelper;
@@ -157 +157 @@
     /**
      * Event triggered when a preference entry value changes.
-     */
+     * @deprecated use {@link org.openstreetmap.josm.spi.preferences.PreferenceChangeEvent}
+     */
+    @Deprecated
     public interface PreferenceChangeEvent {
         /**
@@ -181 +183 @@
      * Listener to preference change events.
      * @since 10600 (functional interface)
+     * @deprecated use {@link org.openstreetmap.josm.spi.preferences.PreferenceChangedListener}
      */
     @FunctionalInterface
+    @Deprecated
     public interface PreferenceChangedListener {
         /**
@@ -191 +195 @@
     }
 
+    @Deprecated
     private static class DefaultPreferenceChangeEvent implements PreferenceChangeEvent {
         private final String key;
@@ -218 +223 @@
     }
 
-    private final ListenerList<PreferenceChangedListener> listeners = ListenerList.create();
-
-    private final HashMap<String, ListenerList<PreferenceChangedListener>> keyListeners = new HashMap<>();
+    private final ListenerList<org.openstreetmap.josm.spi.preferences.PreferenceChangedListener> listeners = ListenerList.create();
+
+    private final HashMap<String, ListenerList<org.openstreetmap.josm.spi.preferences.PreferenceChangedListener>> keyListeners = new HashMap<>();
+
+    @Deprecated
+    private final ListenerList<Preferences.PreferenceChangedListener> listenersDeprecated = ListenerList.create();
+
+    @Deprecated
+    private final HashMap<String, ListenerList<Preferences.PreferenceChangedListener>> keyListenersDeprecated = new HashMap<>();
 
     /**
@@ -243 +254 @@
      * Adds a new preferences listener.
      * @param listener The listener to add
+     * @since xxx
      */
     @Override
-    public void addPreferenceChangeListener(PreferenceChangedListener listener) {
+    public void addPreferenceChangeListener(org.openstreetmap.josm.spi.preferences.PreferenceChangedListener listener) {
         if (listener != null) {
             listeners.addListener(listener);
@@ -252 +264 @@
 
     /**
+     * Adds a new preferences listener.
+     * @param listener The listener to add
+     * @deprecated use {@link #addPreferenceChangeListener(org.openstreetmap.josm.spi.preferences.PreferenceChangedListener)}
+     */
+    @Deprecated
+    public void addPreferenceChangeListener(Preferences.PreferenceChangedListener listener) {
+        if (listener != null) {
+            listenersDeprecated.addListener(listener);
+        }
+    }
+
+    /**
      * Removes a preferences listener.
      * @param listener The listener to remove
+     * @since xxx
      */
     @Override
-    public void removePreferenceChangeListener(PreferenceChangedListener listener) {
+    public void removePreferenceChangeListener(org.openstreetmap.josm.spi.preferences.PreferenceChangedListener listener) {
         listeners.removeListener(listener);
+    }
+
+    /**
+     * Removes a preferences listener.
+     * @param listener The listener to remove
+     * @deprecated use {@link #removePreferenceChangeListener(org.openstreetmap.josm.spi.preferences.PreferenceChangedListener)}
+     */
+    @Deprecated
+    public void removePreferenceChangeListener(Preferences.PreferenceChangedListener listener) {
+        listenersDeprecated.removeListener(listener);
+    }
+
+    /**
+     * Adds a listener that only listens to changes in one preference
+     * @param key The preference key to listen to
+     * @param listener The listener to add.
+     * @since xxx
+     */
+    @Override
+    public void addKeyPreferenceChangeListener(String key, org.openstreetmap.josm.spi.preferences.PreferenceChangedListener listener) {
+        listenersForKey(key).addListener(listener);
     }
 
@@ -265 +311 @@
      * @param listener The listener to add.
      * @since 10824
-     */
-    @Override
-    public void addKeyPreferenceChangeListener(String key, PreferenceChangedListener listener) {
-        listenersForKey(key).addListener(listener);
+     * @deprecated use {@link #addKeyPreferenceChangeListener(java.lang.String, org.openstreetmap.josm.spi.preferences.PreferenceChangedListener)}
+     */
+    @Deprecated
+    public void addKeyPreferenceChangeListener(String key, Preferences.PreferenceChangedListener listener) {
+        listenersForKeyDeprecated(key).addListener(listener);
     }
 
@@ -277 +324 @@
      * @since 10824
      */
-    public void addWeakKeyPreferenceChangeListener(String key, PreferenceChangedListener listener) {
+    public void addWeakKeyPreferenceChangeListener(String key, org.openstreetmap.josm.spi.preferences.PreferenceChangedListener listener) {
         listenersForKey(key).addWeakListener(listener);
     }
 
-    private ListenerList<PreferenceChangedListener> listenersForKey(String key) {
+    private ListenerList<org.openstreetmap.josm.spi.preferences.PreferenceChangedListener> listenersForKey(String key) {
         return keyListeners.computeIfAbsent(key, k -> ListenerList.create());
+    }
+
+    @Deprecated
+    private ListenerList<Preferences.PreferenceChangedListener> listenersForKeyDeprecated(String key) {
+        return keyListenersDeprecated.computeIfAbsent(key, k -> ListenerList.create());
     }
 
@@ -289 +341 @@
      * @param key The preference key to listen to
      * @param listener The listener to add.
+     * @since xxx
      */
     @Override
-    public void removeKeyPreferenceChangeListener(String key, PreferenceChangedListener listener) {
+    public void removeKeyPreferenceChangeListener(String key, org.openstreetmap.josm.spi.preferences.PreferenceChangedListener listener) {
         Optional.ofNullable(keyListeners.get(key)).orElseThrow(
                 () -> new IllegalArgumentException("There are no listeners registered for " + key))
@@ -297 +350 @@
     }
 
+    /**
+     * Removes a listener that only listens to changes in one preference
+     * @param key The preference key to listen to
+     * @param listener The listener to add.
+     * @deprecated use {@link #removeKeyPreferenceChangeListener(java.lang.String, org.openstreetmap.josm.spi.preferences.PreferenceChangedListener)}
+     */
+    @Deprecated
+    public void removeKeyPreferenceChangeListener(String key, Preferences.PreferenceChangedListener listener) {
+        Optional.ofNullable(keyListenersDeprecated.get(key)).orElseThrow(
+                () -> new IllegalArgumentException("There are no listeners registered for " + key))
+        .removeListener(listener);
+    }
+
     protected void firePreferenceChanged(String key, Setting<?> oldValue, Setting<?> newValue) {
-        final PreferenceChangeEvent evt = new DefaultPreferenceChangeEvent(key, oldValue, newValue);
+        final org.openstreetmap.josm.spi.preferences.PreferenceChangeEvent evt = new org.openstreetmap.josm.spi.preferences.DefaultPreferenceChangeEvent(key, oldValue, newValue);
         listeners.fireEvent(listener -> listener.preferenceChanged(evt));
 
-        ListenerList<PreferenceChangedListener> forKey = keyListeners.get(key);
+        ListenerList<org.openstreetmap.josm.spi.preferences.PreferenceChangedListener> forKey = keyListeners.get(key);
         if (forKey != null) {
             forKey.fireEvent(listener -> listener.preferenceChanged(evt));
+        }
+        firePreferenceChangedDeprecated(key, oldValue, newValue);
+    }
+
+    @Deprecated
+    private void firePreferenceChangedDeprecated(String key, Setting<?> oldValue, Setting<?> newValue) {
+        final Preferences.PreferenceChangeEvent evtDeprecated = new Preferences.DefaultPreferenceChangeEvent(key, oldValue, newValue);
+        listenersDeprecated.fireEvent(listener -> listener.preferenceChanged(evtDeprecated));
+
+        ListenerList<Preferences.PreferenceChangedListener> forKeyDeprecated = keyListenersDeprecated.get(key);
+        if (forKeyDeprecated != null) {
+            forKeyDeprecated.fireEvent(listener -> listener.preferenceChanged(evtDeprecated));
         }
     }