Changeset 6767 in josm for trunk/src/org/openstreetmap/josm/gui/preferences/advanced/PrefEntry.java

Timestamp:

2014-01-29T16:18:16+01:00 (10 years ago)

Author:

Don-vip

Message:

javadoc for gui.preferences.advanced package

File:

• trunk/src/org/openstreetmap/josm/gui/preferences/advanced/PrefEntry.java (modified) (4 diffs)

trunk/src/org/openstreetmap/josm/gui/preferences/advanced/PrefEntry.java

@@ -6 +6 @@
 
 /**
- * Class to store single preference line for the table
- * @since 6021 : extracted from AdvancedPreference class 
+ * Class to store single preference line for the table.
+ * @since 6021
  */
 public class PrefEntry implements Comparable<PrefEntry> {
@@ -16 +16 @@
     private boolean changed;
 
+    /**
+     * Constructs a new {@code PrefEntry}.
+     * @param key The preference key
+     * @param value The preference value
+     * @param defaultValue The preference default value
+     * @param isDefault determines if the current value is the default value
+     */
     public PrefEntry(String key, Preferences.Setting value, Preferences.Setting defaultValue, boolean isDefault) {
         CheckParameterUtil.ensureParameterNotNull(key);
@@ -26 +33 @@
     }
 
+    /**
+     * Returns the preference key.
+     * @return the preference key
+     */
     public String getKey() {
         return key;
     }
 
+    /**
+     * Returns the preference value.
+     * @return the preference value
+     */
     public Preferences.Setting getValue() {
         return value;
     }
 
+    /**
+     * Returns the preference default value.
+     * @return the preference default value
+     */
     public Preferences.Setting getDefaultValue() {
         return defaultValue;
     }
 
+    /**
+     * Sets the preference value.
+     * @param value the preference value
+     */
     public void setValue(Preferences.Setting value) {
         this.value = value;
@@ -44 +67 @@
     }
 
+    /**
+     * Determines if the current value is the default value.
+     * @return {@code true} if the current value is the default value, {@code false} otherwise
+     */
     public boolean isDefault() {
         return isDefault;
     }
 
+    /**
+     * Determines if this preference entry has been modified.
+     * @return {@code true} if this preference entry has been modified, {@code false} otherwise
+     */
     public boolean isChanged() {
         return changed;
     }
 
+    /**
+     * Marks this preference entry as modified.
+     */
     public void markAsChanged() {
         changed = true;
     }
 
+    /**
+     * Resets this preference entry to default state.
+     */
     public void reset() {
         value = defaultValue;