Changeset 9417 in josm for trunk/src/org/openstreetmap/josm

Timestamp:

2016-01-12T00:59:37+01:00 (8 years ago)

Author:

Don-vip

Message:

checkstyle + javadoc

File:

• trunk/src/org/openstreetmap/josm/gui/preferences/SourceEditor.java (modified) (8 diffs)

trunk/src/org/openstreetmap/josm/gui/preferences/SourceEditor.java

@@ -23 +23 @@
 import java.io.File;
 import java.io.IOException;
-import java.io.InputStream;
-import java.io.InputStreamReader;
 import java.net.MalformedURLException;
 import java.net.URL;
-import java.nio.charset.StandardCharsets;
 import java.util.ArrayList;
 import java.util.Arrays;
@@ -452 +449 @@
     }
 
+    /**
+     * Determines whether the list of active sources has changed.
+     * @return {@code true} if the list of active sources has changed, {@code false} otherwise
+     */
     public boolean hasActiveSourcesChanged() {
         Collection<? extends SourceEntry> prev = getInitialSourcesList();
@@ -468 +469 @@
     }
 
+    /**
+     * Returns the list of active sources.
+     * @return the list of active sources
+     */
     public Collection<SourceEntry> getActiveSources() {
         return activeSourcesModel.getSources();
@@ -486 +491 @@
     }
 
+    /**
+     * Remove sources associated with given indexes from active list.
+     * @param idxs indexes of sources to remove
+     */
     public void removeSources(Collection<Integer> idxs) {
         activeSourcesModel.removeIdxs(idxs);
@@ -696 +705 @@
 
     public static class ExtendedSourceEntry extends SourceEntry implements Comparable<ExtendedSourceEntry> {
+        /** file name used for display */
         public String simpleFileName;
+        /** version used for display */
         public String version;
+        /** author name used for display */
         public String author;
+        /** webpage link used for display */
         public String link;
+        /** short description used for display */
         public String description;
         /** Style type: can only have one value: "xml". Used to filter out old XML styles. For MapCSS styles, the value is not set. */
         public String styleType;
+        /** minimum JOSM version required to enable this source entry */
         public Integer minJosmVersion;
 
+        /**
+         * Constructs a new {@code ExtendedSourceEntry}.
+         * @param simpleFileName file name used for display
+         * @param url URL that {@link org.openstreetmap.josm.io.CachedFile} understands
+         */
         public ExtendedSourceEntry(String simpleFileName, String url) {
             super(url, null, null, true);
@@ -721 +741 @@
         }
 
+        /**
+         * Returns a tooltip containing available metadata.
+         * @return a tooltip containing available metadata
+         */
         public String getTooltip() {
             StringBuilder s = new StringBuilder();
@@ -1630 +1654 @@
         public abstract Collection<ExtendedSourceEntry> getDefault();
 
+        /**
+         * Serializes the given source entry as a map.
+         * @param entry source entry to serialize
+         * @return map (key=value)
+         */
         public abstract Map<String, String> serialize(SourceEntry entry);
 
+        /**
+         * Deserializes the given map as a source entry.
+         * @param entryStr map (key=value)
+         * @return source entry
+         */
         public abstract SourceEntry deserialize(Map<String, String> entryStr);
 
@@ -1654 +1688 @@
         }
 
+        /**
+         * Saves a list of sources to JOSM preferences.
+         * @param entries list of sources
+         * @return {@code true}, if something has changed (i.e. value is different than before)
+         */
         public boolean put(Collection<? extends SourceEntry> entries) {
             Collection<Map<String, String>> setting = new ArrayList<>(entries.size());