Changeset 8420 in josm

Timestamp:

2015-05-23T08:55:03+02:00 (10 years ago)

Author:

wiktorn

Message:

Java docs for @8418, addresses #11456

Location:

trunk

Files:

• data/maps.xsd (modified) (1 diff)
• src/org/openstreetmap/josm/data/cache/CacheEntryAttributes.java (modified) (6 diffs)
• src/org/openstreetmap/josm/data/imagery/ImageryInfo.java (modified) (2 diffs)

trunk/data/maps.xsd

@@ -681 +681 @@
                                                         <!-- tile size provided by imagery source. Default - 256 -->
                                                         <xs:element name="tile-size" minOccurs="0" maxOccurs="1" type="xs:positiveInteger" />
-                                                        <!--  HTTP headers that contain valuable informatin and that will be shown on "Shown Tile Info" dialog -->
+                                                        <!--  HTTP headers that contain valuable information and that will be shown on "Shown Tile Info" dialog -->
                                                         <xs:element name="metadata-header" minOccurs="0" maxOccurs="unbounded">
                                                                 <xs:complexType>

trunk/src/org/openstreetmap/josm/data/cache/CacheEntryAttributes.java

@@ -14 +14 @@
 
 /**
- * Class that contains attirubtes for JCS cache entries. Parameters are used to properly handle HTTP caching
+ * Class that contains attirubtes for JCS cache entries. Parameters are used to properly handle HTTP caching,
+ * and metadata structures, that should be stored together with the cache entry
  *
  * @author Wiktor Niesiobędzki
@@ -47 +48 @@
     }
 
+    /**
+     * @return if the entry is marked as "no tile at this zoom level"
+     */
     public boolean isNoTileAtZoom() {
         return Boolean.toString(true).equals(attrs.get(NO_TILE_AT_ZOOM));
     }
+
+    /**
+     * Sets the marker for "no tile at this zoom level"
+     * @param noTileAtZoom true if this entry is "no tile at this zoom level"
+     */
     public void setNoTileAtZoom(boolean noTileAtZoom) {
         attrs.put(NO_TILE_AT_ZOOM, Boolean.toString(noTileAtZoom));
     }
+
+    /**
+     * @return ETag header value, that was returned for this entry.
+     */
     public String getEtag() {
         return attrs.get(ETAG);
     }
+
+    /**
+     * Sets the ETag header that was set with this entry
+     * @param etag Etag header
+     */
     public void setEtag(String etag) {
         if(etag != null) {
@@ -62 +80 @@
     }
 
+    /**
+     * Utility for conversion from String to int, with default to 0, in case of any errors
+     *
+     * @param key - integer as string
+     * @return int value of the string
+     */
     private long getLongAttr(String key) {
         String val = attrs.get(key);
@@ -76 +100 @@
     }
 
+    /**
+     * @return last modification of the object in cache in milliseconds from Epoch
+     */
     public long getLastModification() {
         return getLongAttr(LAST_MODIFICATION);
     }
+
+    /**
+     * sets last modification of the object in cache
+     *
+     * @param lastModification time in format of milliseconds from Epoch
+     */
     public void setLastModification(long lastModification) {
         attrs.put(LAST_MODIFICATION, Long.toString(lastModification));
     }
+
+    /**
+     * @return when the object expires in milliseconds from Epoch
+     */
     public long getExpirationTime() {
         return getLongAttr(EXPIRATION_TIME);
     }
+
+    /**
+     * sets expiration time for the object in cache
+     *
+     * @param expirationTime in format of milliseconds from epoch
+     */
     public void setExpirationTime(long expirationTime) {
         attrs.put(EXPIRATION_TIME, Long.toString(expirationTime));
     }
 
+    /**
+     * Sets the HTTP response code that was sent with the cache entry
+     *
+     * @param responseCode http status code
+     * @since 8389
+     */
     public void setResponseCode(int responseCode) {
         attrs.put(HTTP_RESPONSE_CODE, Integer.toString(responseCode));
     }
 
+    /**
+     * @return http status code
+     * @since 8389
+     */
     public int getResponseCode() {
         return (int) getLongAttr(HTTP_RESPONSE_CODE);
@@ -102 +155 @@
      *
      * @param map metadata to save
+     * @since 8418
      */
     public void setMetadata(Map<String, String> map) {
@@ -115 +169 @@
     /**
      * Returns an unmodifiable Map containing all metadata. Unmodifiable prevents access to metadata within attributes.
+     *
      * @return unmodifiable Map with cache element metadata
+     * @since 8418
      */
     public Map<String, String> getMetadata() {

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

@@ -1022 +1022 @@
     }
 
+    /**
+     * Sets the Map of <header name, header value> that if any of this header
+     * will be returned, then this tile will be treated as "no tile at this zoom level"
+     *
+     * @param noTileHeaders
+     * @since 8344
+     */
     public void setNoTileHeaders(Map<String, String> noTileHeaders) {
        this.noTileHeaders = noTileHeaders;
@@ -1031 +1038 @@
     }
 
+    /**
+     * Returns the map <header name, metadata key> indicating, which HTTP headers should
+     * be moved to metadata
+     *
+     * @param metadataHeaders
+     * @since 8418
+     */
     public void setMetadataHeaders(Map<String, String> metadataHeaders) {
         this.metadataHeaders = metadataHeaders;