Changeset 10194 in josm for trunk/src/org/openstreetmap/josm/io

Timestamp:

2016-05-11T22:29:43+02:00 (10 years ago)

Author:

Don-vip

Message:

sonar, javadoc

Location:

trunk/src/org/openstreetmap/josm/io

Files:

• BoundingBoxDownloader.java (modified) (2 diffs)
• CachedFile.java (modified) (1 diff)
• ChangesetQuery.java (modified) (6 diffs)

trunk/src/org/openstreetmap/josm/io/BoundingBoxDownloader.java

@@ -237 +237 @@
         public final int limit;
 
+        /**
+         * Constructs a {@code MoreNotesException}.
+         * @param notes downloaded notes
+         * @param limit download limit sent to the server
+         */
         public MoreNotesException(List<Note> notes, int limit) {
             this.notes = notes;
@@ -242 +247 @@
         }
     }
-
 }

trunk/src/org/openstreetmap/josm/io/CachedFile.java

@@ -176 +176 @@
     }
 
+    /**
+     * Returns maximum age of cache file. Only applies to URLs.
+     * When this time has passed after the last download of the file, the
+     * cache is considered stale and a new download will be attempted.
+     * @return the maximum cache age in seconds
+     */
     public long getMaxAge() {
         return maxAge;

trunk/src/org/openstreetmap/josm/io/ChangesetQuery.java

@@ -28 +28 @@
      * Maximum number of changesets returned by the OSM API call "/changesets?"
      */
-    public static int MAX_CHANGESETS_NUMBER = 100;
-
-    /**
-     * Replies a changeset query object from the query part of a OSM API URL for querying changesets.
-     *
-     * @param query the query part
-     * @return the query object
-     * @throws ChangesetQueryUrlException if query doesn't consist of valid query parameters
-     */
-    public static ChangesetQuery buildFromUrlQuery(String query) throws ChangesetQueryUrlException {
-        return new ChangesetQueryUrlParser().parse(query);
-    }
+    public static final int MAX_CHANGESETS_NUMBER = 100;
 
     /** the user id this query is restricted to. null, if no restriction to a user id applies */
@@ -56 +45 @@
     /** a collection of changeset ids to query for */
     private Collection<Long> changesetIds;
+
+    /**
+     * Replies a changeset query object from the query part of a OSM API URL for querying changesets.
+     *
+     * @param query the query part
+     * @return the query object
+     * @throws ChangesetQueryUrlException if query doesn't consist of valid query parameters
+     */
+    public static ChangesetQuery buildFromUrlQuery(String query) throws ChangesetQueryUrlException {
+        return new ChangesetQueryUrlParser().parse(query);
+    }
 
     /**
@@ -305 +305 @@
     }
 
+    /**
+     * Exception thrown for invalid changeset queries.
+     */
     public static class ChangesetQueryUrlException extends Exception {
 
@@ -339 +342 @@
     }
 
+    /**
+     * Changeset query URL parser.
+     */
     public static class ChangesetQueryUrlParser {
         protected int parseUid(String value) throws ChangesetQueryUrlException {
@@ -486 +492 @@
          * </pre>
          *
-         * @param query the query string. If null, an empty query (identical to a query for all changesets) is
-         * assumed
+         * @param query the query string. If null, an empty query (identical to a query for all changesets) is assumed
          * @return the changeset query
          * @throws ChangesetQueryUrlException if the query string doesn't represent a legal query for changesets
@@ -494 +499 @@
             if (query == null)
                 return new ChangesetQuery();
-            query = query.trim();
-            if (query.isEmpty())
+            String apiQuery = query.trim();
+            if (apiQuery.isEmpty())
                 return new ChangesetQuery();
-            Map<String, String> queryParams = createMapFromQueryString(query);
-            return createFromMap(queryParams);
+            return createFromMap(createMapFromQueryString(apiQuery));
         }
     }