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

Timestamp:

2016-09-17T23:13:48+02:00 (8 years ago)

Author:

Don-vip

Message:

javadoc

File:

• trunk/src/org/openstreetmap/josm/io/NameFinder.java (modified) (4 diffs)

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

@@ -7 +7 @@
 import java.io.Reader;
 import java.net.URL;
+import java.util.Collections;
 import java.util.LinkedList;
 import java.util.List;
@@ -40 +41 @@
     }
 
+    /**
+     * Performs a Nominatim search.
+     * @param searchExpression Nominatim search expression
+     * @return search results
+     * @throws IOException if any IO error occurs.
+     */
     public static List<SearchResult> queryNominatim(final String searchExpression) throws IOException {
         return query(new URL(NOMINATIM_URL + Utils.encodeUrl(searchExpression)));
     }
 
+    /**
+     * Performs a custom search.
+     * @param url search URL to any Nominatim instance
+     * @return search results
+     * @throws IOException if any IO error occurs.
+     */
     public static List<SearchResult> query(final URL url) throws IOException {
         final HttpClient connection = HttpClient.create(url);
@@ -54 +67 @@
     }
 
+    /**
+     * Parse search results as returned by Nominatim.
+     * @param reader reader
+     * @return search results
+     * @throws ParserConfigurationException if a parser cannot be created which satisfies the requested configuration.
+     * @throws SAXException for SAX errors.
+     * @throws IOException if any IO error occurs.
+     */
     public static List<SearchResult> parseSearchResults(Reader reader) throws IOException, ParserConfigurationException, SAXException {
         InputSource inputSource = new InputSource(reader);
@@ -249 +270 @@
 
         public List<SearchResult> getResult() {
-            return data;
+            return Collections.unmodifiableList(data);
         }
     }