Changeset 9821 in josm for trunk/src/org/openstreetmap/josm/data/preferences/Setting.java

Timestamp:

2016-02-18T11:07:38+01:00 (10 years ago)

Author:

bastiK

Message:

fixed #12522 - Advanced preferences: display default entries consistently

Saves default preference entries to a cache file (cache/default_preferences.xml), so the list of advanced preferences is filled with all known default values consistently from the start and not gradually as you use different features during a session.

File:

• trunk/src/org/openstreetmap/josm/data/preferences/Setting.java (modified) (2 diffs)

trunk/src/org/openstreetmap/josm/data/preferences/Setting.java

@@ -1 +1 @@
 // License: GPL. For details, see LICENSE file.
 package org.openstreetmap.josm.data.preferences;
+
+import org.openstreetmap.josm.data.Preferences;
 
 /**
@@ -46 +48 @@
      */
     Setting<T> getNullInstance();
+
+    /**
+     * Set the time for this setting.
+     *
+     * For default preferences. They are saved in a cache file. Keeping the
+     * time allows to discard very old default settings.
+     * @param time the time in seconds since epoch
+     */
+    void setTime(Long time);
+
+    /**
+     * Get the time for this setting.
+     * @return the time for this setting
+     * @see #setTime(java.lang.Long)
+     */
+    Long getTime();
+
+    /**
+     * Mark setting as new.
+     *
+     * For default preferences. A setting is marked as new, if it has been seen
+     * in the current session.
+     * Methods like {@link Preferences#get(java.lang.String, java.lang.String)},
+     * can be called from different parts of the code with the same key. In this case,
+     * the supplied default value must match. However, this is only an error if the mismatching
+     * default value has been seen in the same session (and not loaded from cache).
+     * @param isNew true, if it is new
+     */
+    void setNew(boolean isNew);
+
+    /**
+     * Return if the setting has been marked as new.
+     * @return true, if the setting has been marked as new
+     * @see #setNew(boolean)
+     */
+    boolean isNew();
 }