Changeset 13742 in josm for trunk/src/org/openstreetmap/josm/data/imagery

Timestamp:

2018-05-13T09:15:34+02:00 (6 years ago)

Author:

wiktorn

Message:

Checkstyle fixes

Location:

trunk/src/org/openstreetmap/josm/data/imagery

Files:

• GetCapabilitiesParseHelper.java (modified) (1 diff)
• ImageryInfo.java (modified) (2 diffs)
• LayerDetails.java (modified) (8 diffs)
• TileJobOptions.java (modified) (1 diff)
• WMSEndpointTileSource.java (modified) (1 diff)
• WMTSTileSource.java (modified) (3 diffs)

trunk/src/org/openstreetmap/josm/data/imagery/GetCapabilitiesParseHelper.java

@@ -117 +117 @@
      * @param reader XMLStreamReader that should point to start of element
      * @return content of current tag
-     * @throws XMLStreamException
+     * @throws XMLStreamException if any XML stream error occurs
      */
     public static String getElementTextWithSubtags(XMLStreamReader reader) throws XMLStreamException {

trunk/src/org/openstreetmap/josm/data/imagery/ImageryInfo.java

@@ -1432 +1432 @@
     /**
      * Sets custom HTTP headers that should be sent with request towards imagery provider
-     * @param customHttpHeaders
+     * @param customHttpHeaders http headers
      */
     public void setCustomHttpHeaders(Map<String, String> customHttpHeaders) {
@@ -1462 +1462 @@
     /**
      * Sets minimum tile expiration in seconds
-     * @param minimumTileExpire
+     * @param minimumTileExpire minimum tile expiration in seconds
      */
     public void setMinimumTileExpire(int minimumTileExpire) {

trunk/src/org/openstreetmap/josm/data/imagery/LayerDetails.java

@@ -38 +38 @@
      * This is needed to properly handle layer attributes inheritance.
      *
-     * @param parentLayer
+     * @param parentLayer parent layer
      */
     public LayerDetails(LayerDetails parentLayer) {
@@ -70 +70 @@
 
     /**
+     * @return title "Human readable" title of this layer
      * @see LayerDetails#getName()
-     * @return title "Human readable" title of this layer
      */
     public String getTitle() {
@@ -78 +78 @@
 
     /**
+     * @param title set title of this layer
      * @see LayerDetails#getName()
-     * @param title set title of this layer
      */
     public void setTitle(String title) {
@@ -88 +88 @@
      *
      * Citation from OGC WMS specification (WMS 1.3.0):
-     * > A number of elements have both a <Name> and a <Title>. The Name is a text string used for machine-to-machine
+     * > A number of elements have both a {@literal <Name>} and a {@literal <Title>}. The Name is a text string used for machine-to-machine
      * > communication while the Title is for the benefit of humans. For example, a dataset might have the descriptive Title
      * > “Maximum Atmospheric Temperature” and be requested using the abbreviated Name “ATMAX”.
      *
      * And second citation:
-     * > If, and only if, a layer has a <Name>, then it is a map layer that can be requested by using that Name in the
-     * > LAYERS parameter of a GetMap request. A Layer that contains a <Name> element is referred to as a “named
+     * > If, and only if, a layer has a {@literal <Name>}, then it is a map layer that can be requested by using that Name in the
+     * > LAYERS parameter of a GetMap request. A Layer that contains a {@literal <Name>} element is referred to as a “named
      * > layer” in this International Standard. If the layer has a Title but no Name, then that layer is only a category title for
      * > all the layers nested within.
@@ -104 +104 @@
 
     /**
+     * @param name sets the name of this Layer
      * @see LayerDetails#getName()
-     * @param name sets the name of this Layer
      */
     public void setName(String name) {
@@ -138 +138 @@
     /**
      * sets bounds of this layer
-     * @param bounds
+     * @param bounds of this layer
      */
     public void setBounds(Bounds bounds) {
@@ -160 +160 @@
     /**
      * sets children layers for this layer
-     * @param children
+     * @param children children of this layer
      */
     public void setChildren(List<LayerDetails> children) {
@@ -192 +192 @@
     /**
      * Sets abstract of this layer
-     * @param abstr
+     * @param abstr abstract of this layer
      */
     public void setAbstract(String abstr) {

trunk/src/org/openstreetmap/josm/data/imagery/TileJobOptions.java

@@ -23 +23 @@
      * @param connectTimeout in milliseconds
      * @param readTimeout in milliseconds
-     * @param headers
+     * @param headers http headers
      * @param minimumExpiryTime in seconds
      */

trunk/src/org/openstreetmap/josm/data/imagery/WMSEndpointTileSource.java

@@ -31 +31 @@
     private List<DefaultLayer> layers;
     private String urlPattern;
-    private static final Pattern PATTERN_PARAM  = Pattern.compile("\\{([^}]+)\\}");
+    private static final Pattern PATTERN_PARAM = Pattern.compile("\\{([^}]+)\\}");
     private final Map<String, String> headers = new ConcurrentHashMap<>();
 

trunk/src/org/openstreetmap/josm/data/imagery/WMTSTileSource.java

@@ -303 +303 @@
      * @param info imagery info
      * @throws IOException if any I/O error occurs
-     * @throws WMTSGetCapabilitiesException
+     * @throws WMTSGetCapabilitiesException when document didn't contain any layers
      * @throws IllegalArgumentException if any other error happens for the given imagery info
      */
@@ -312 +312 @@
         this.baseUrl = GetCapabilitiesParseHelper.normalizeCapabilitiesUrl(handleTemplate(info.getUrl()));
         WMTSCapabilities capabilities = getCapabilities(baseUrl, headers);
-        this.layers =  capabilities.getLayers();
+        this.layers = capabilities.getLayers();
         this.baseUrl = capabilities.getBaseUrl();
         this.transferMode = capabilities.getTransferMode();
@@ -374 +374 @@
      * @return capabilities
      * @throws IOException in case of any I/O error
-     * @throws WMTSGetCapabilitiesException
+     * @throws WMTSGetCapabilitiesException when document didn't contain any layers
      * @throws IllegalArgumentException in case of any other error
      */