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

Timestamp:

2017-07-13T22:14:20+02:00 (7 years ago)

Author:

Don-vip

Message:

see #15012 - checkstyle + javadoc

File:

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

trunk/src/org/openstreetmap/josm/io/imagery/WMSImagery.java

@@ -173 +173 @@
     }
 
+    /**
+     * Returns the URL for the "GetMap" WMS request in JPEG format.
+     * @param selectedLayers the list of selected layers, matching the "LAYERS" WMS request argument
+     * @return the URL for the "GetMap" WMS request
+     */
     public String buildGetMapUrl(Collection<LayerDetails> selectedLayers) {
         return buildGetMapUrl(selectedLayers, "image/jpeg");
     }
 
+    /**
+     * Returns the URL for the "GetMap" WMS request.
+     * @param selectedLayers the list of selected layers, matching the "LAYERS" WMS request argument
+     * @param format the requested image format, matching the "FORMAT" WMS request argument
+     * @return the URL for the "GetMap" WMS request
+     */
     public String buildGetMapUrl(Collection<LayerDetails> selectedLayers, String format) {
         return buildRootUrl() + "FORMAT=" + format + (imageFormatHasTransparency(format) ? "&TRANSPARENT=TRUE" : "")
@@ -184 +195 @@
     }
 
+    /**
+     * Attempts WMS "GetCapabilities" request and initializes internal variables if successful.
+     * @param serviceUrlStr WMS service URL
+     * @throws IOException if any I/O errors occurs
+     * @throws WMSGetCapabilitiesException if the WMS server replies a ServiceException
+     */
     public void attemptGetCapabilities(String serviceUrlStr) throws IOException, WMSGetCapabilitiesException {
         URL getCapabilitiesUrl = null;
@@ -288 +305 @@
     }
 
+    /**
+     * Returns a new {@code ImageryInfo} describing the given service name and selected WMS layers.
+     * @param name service name
+     * @param selectedLayers selected WMS layers
+     * @return a new {@code ImageryInfo} describing the given service name and selected WMS layers
+     */
     public ImageryInfo toImageryInfo(String name, Collection<LayerDetails> selectedLayers) {
         ImageryInfo i = new ImageryInfo(name, buildGetMapUrl(selectedLayers));
@@ -345 +368 @@
             bboxElem = getChild(element, "LatLonBoundingBox");
             if (bboxElem != null) {
-                double left = getDecimalDegree(bboxElem ,"minx");
+                double left = getDecimalDegree(bboxElem, "minx");
                 double top = getDecimalDegree(bboxElem, "maxy");
                 double right = getDecimalDegree(bboxElem, "maxx");