Changeset 9129 in josm

Timestamp:

2015-12-15T11:11:43+01:00 (8 years ago)

Author:

bastiK

Message:

javadoc

File:

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

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

@@ -1284 +1284 @@
     }
 
-    @Retention(RetentionPolicy.RUNTIME) public @interface pref { }
-    @Retention(RetentionPolicy.RUNTIME) public @interface writeExplicitly { }
+    /**
+     * Annotation used for converting objects to String Maps and vice versa.
+     * Indicates that a certain field should be considered in the conversion
+     * process. Otherwise it is ignored.
+     * 
+     * @see #serializeStruct(java.lang.Object, java.lang.Class)
+     * @see #deserializeStruct(java.util.Map, java.lang.Class) 
+     */
+    @Retention(RetentionPolicy.RUNTIME) // keep annotation at runtime
+    public @interface pref { }
+
+    /**
+     * Annotation used for converting objects to String Maps.
+     * Indicates that a certain field should be written to the map, even if
+     * the value is the same as the default value.
+     * 
+     * @see #serializeStruct(java.lang.Object, java.lang.Class)
+     */
+    @Retention(RetentionPolicy.RUNTIME) // keep annotation at runtime
+    public @interface writeExplicitly { }
 
     /**
@@ -1322 +1340 @@
 
     /**
-     * Save a list of hashes represented by a struct-like class.
+     * Convenience method that saves a MapListSetting which is provided as a
+     * Collection of objects.
+     * 
+     * Each object is converted to a <code>Map&lt;String, String&gt;</code> using
+     * the fields with {@link pref} annotation. The field name is the key and
+     * the value will be converted to a string.
+     * 
      * Considers only fields that have the @pref annotation.
      * In addition it does not write fields with null values. (Thus they are cleared)
@@ -1329 +1353 @@
      * Fields equal to the default value are not written unless the field has
      * the @writeExplicitly annotation.
+     * @param <T> the class, 
      * @param key main preference key
      * @param val the list that is supposed to be saved
@@ -1384 +1409 @@
     }
 
+    /**
+     * Convert an object to a String Map, by using field names and values as map
+     * key and value.
+     * 
+     * The field value is converted to a String.
+     * 
+     * Only fields with annotation {@link pref} are taken into account.
+     * 
+     * Fields will not be written to the map if the value is null or unchanged
+     * (compared to an object created with the no-arg-constructor).
+     * The {@link writeExplicitly} annotation overrides this behavior, i.e. the
+     * default value will also be written.
+     * 
+     * @param <T> the class of the object <code>struct</code>
+     * @param struct the object to be converted
+     * @param klass the class T
+     * @return the resulting map (same data content as <code>struct</code>)
+     */
     public static <T> Map<String, String> serializeStruct(T struct, Class<T> klass) {
         T structPrototype;
@@ -1418 +1461 @@
     }
 
+    /**
+     * Converts a String-Map to an object of a certain class, by comparing
+     * map keys to field names of the class and assigning map values to the
+     * corresponding fields.
+     * 
+     * The map value (a String) is converted to the field type. Supported
+     * types are: boolean, Boolean, int, Integer, double, Double, String and
+     * Map&lt;String, String&gt;.
+     * 
+     * Only fields with annotation {@link pref} are taken into account.
+     * @param <T> the class
+     * @param hash the string map with initial values
+     * @param klass the class T
+     * @return an object of class T, initialized as described above
+     */
     public static <T> T deserializeStruct(Map<String, String> hash, Class<T> klass) {
         T struct = null;