fixed javadoc

Author: Synapticloop

src/main/java/synapticloop/b2/request/B2DownloadFileByIdRequest.java

@@ -25,9 +25,9 @@
 
 /**
  * <p>Downloads one file from B2.</p>
- * <p>
+ * 
  * <p>The response contains the following headers, which contain the same information they did when the file was uploaded:</p>
- * <p>
+ * 
  * <ul>
  * <li>Content-Length</li>
  * <li>Content-Type</li>
@@ -36,18 +36,18 @@
  * <li>X-Bz-Content-Sha1</li>
  * <li>X-Bz-Info-*</li>
  * </ul>
- * <p>
+ * 
  * <p>HEAD requests are also supported, and work just like a GET, except that the
  * body of the response is not included. All of the same headers, including
  * Content-Length are returned. See the B2HeadFileByIdRequest</p>
- * <p>
+ * 
  * <p>If the bucket containing the file is set to require authorization, then you
  * must supply the bucket's auth token in the Authorzation header.</p>
- * <p>
+ * 
  * <p>Because errors can happen in network transmission, you should check the
  * SHA1 of the data you receive against the SHA1 returned in the
  * X-Bz-Content-Sha1 header.</p>
- * <p>
+ * 
  * This is the interaction class for the <strong>b2_download_file_by_id</strong> api calls, this was
  * generated from the backblaze api documentation - which can be found here:
  * <a href="http://www.backblaze.com/b2/docs/b2_download_file_by_id.html">http://www.backblaze.com/b2/docs/b2_download_file_by_id.html</a>
@@ -69,18 +69,22 @@ public B2DownloadFileByIdRequest(CloseableHttpClient client, B2AuthorizeAccountR
 	}
 
 	/**
-	 * Create a download file by ID request to download the range of bytes
+	 * <p>Create a download file by ID request to download the range of bytes
 	 * between rangeStart and rangeEnd (inclusive)
+	 * </p>
 	 * <p>
 	 * A standard byte-range request, which will return just part of the stored file.
+	 * </p>
 	 * <p>
 	 * The value "bytes=0-99" selects bytes 0 through 99 (inclusive) of the file,
 	 * so it will return the first 100 bytes. Valid byte ranges will cause the
 	 * response to contain a Content-Range header that specifies which bytes are
 	 * returned. Invalid byte ranges will just return the whole file.
+	 * </p>
 	 * <p>
 	 * Note that the SHA1 checksum returned is still the checksum for the entire
 	 * file, so it cannot be used on the byte range.
+	 * </p>
 	 *
 	 * @param client                     Shared HTTP client instance
 	 * @param b2AuthorizeAccountResponse The authorize account response

src/main/java/synapticloop/b2/request/BaseB2Request.java

@@ -115,20 +115,29 @@ protected BaseB2Request(CloseableHttpClient client, B2AuthorizeAccountResponse b
 
 	/**
 	 * Add header to request replacing previous if any
+	 * 
+	 * @param key the key to add
+	 * @param value the value to add
 	 */
 	protected void addHeader(String key, String value) {
 		requestHeaders.put(key, value);
 	}
 
 	/**
 	 * Add query parameter to request replacing previous if any
+	 * 
+	 * @param key the key to add
+	 * @param value the value to add
 	 */
 	protected void addParameter(String key, String value) {
 		requestParameters.put(key, value);
 	}
 
 	/**
 	 * Add property to JSON request body
+	 * 
+	 * @param key the key to add
+	 * @param value the value to add
 	 */
 	protected void addProperty(String key, Object value) {
 		requestBodyData.put(key, value);

src/main/java/synapticloop/b2/response/BaseB2Response.java

@@ -1,5 +1,7 @@
 package synapticloop.b2.response;
 
+import java.util.Iterator;
+
 /*
  * Copyright (c) 2016 synapticloop.
  * 
@@ -21,9 +23,8 @@
 import org.json.JSONObject;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-import synapticloop.b2.exception.B2ApiException;
 
-import java.util.Iterator;
+import synapticloop.b2.exception.B2ApiException;
 
 public abstract class BaseB2Response {
 	private static final Logger LOGGER = LoggerFactory.getLogger(BaseB2Response.class);
@@ -69,12 +70,24 @@ private static JSONObject parse(String json) throws B2ApiException {
 	}
 
 	/**
-	 * Read and remove object with key from JSON
+	 * Read and remove String with key from JSON
+	 * 
+	 * @param key the key to read as a string and remove
+	 * 
+	 * @return the read key (or null if it doesn't exist)
 	 */
 	protected String readString(String key) {
 		return this.readString(response, key);
 	}
 
+	/**
+	 * Read and remove String with key from JSON object
+	 * 
+	 * @param response The JSON object to read from
+	 * @param key the key to read as a string and remove
+	 * 
+	 * @return the read key (or null if it doesn't exist)
+	 */
 	protected String readString(JSONObject response, String key) {
 		final Object value = response.remove(key);
 		if (null == value || JSONObject.NULL == value) {
@@ -85,7 +98,11 @@ protected String readString(JSONObject response, String key) {
 	}
 
 	/**
-	 * Read and remove object with key from JSON
+	 * Read and remove int with key from JSON object
+	 * 
+	 * @param key the key to read as an int and remove
+	 * 
+	 * @return the read key (or -1 if it doesn't exist)
 	 */
 	protected int readInt(String key) {
 		final Object value = response.remove(key);
@@ -97,7 +114,11 @@ protected int readInt(String key) {
 	}
 
 	/**
-	 * Read and remove object with key from JSON
+	 * Read and remove long with key from JSON object
+	 * 
+	 * @param key the key to read as a long and remove
+	 * 
+	 * @return the read key (or -1L if it doesn't exist)
 	 */
 	protected long readLong(String key) {
 		final Object value = response.remove(key);
@@ -108,10 +129,25 @@ protected long readLong(String key) {
 		return value instanceof Number ? ((Number) value).longValue() : Long.parseLong(value.toString());
 	}
 
+	/**
+	 * Read and remove JSONObject with key from JSON object
+	 * 
+	 * @param key the key to read as a JSONObject and remove
+	 * 
+	 * @return the read key (or null if it doesn't exist)
+	 */
 	protected JSONObject readObject(String key) {
 		return this.readObject(response, key);
 	}
 
+	/**
+	 * Read and remove JSONObject with key from JSON object
+	 * 
+	 * @param response The JSON object to read from
+	 * @param key the key to read as a JSONObject and remove
+	 * 
+	 * @return the read key (or null if it doesn't exist)
+	 */
 	protected JSONObject readObject(JSONObject response, String key) {
 		final Object value = response.remove(key);
 		if (null == value || JSONObject.NULL == value) {
@@ -122,7 +158,11 @@ protected JSONObject readObject(JSONObject response, String key) {
 	}
 
 	/**
-	 * Read and remove object with key from JSON
+	 * Read and remove JSONArray with key from JSON object
+	 * 
+	 * @param key the key to read as a JSONArray and remove
+	 * 
+	 * @return the read key (or null if it doesn't exist)
 	 */
 	protected JSONArray readObjects(String key) {
 		final Object value = response.remove(key);
@@ -139,7 +179,15 @@ protected JSONArray readObjects(String key) {
 	 * the response will not be mapped.  This will loop through the JSON object
 	 * and any key left in the object will generate a 'WARN' message.  The
 	 * response class __MUST__ remove the object (i.e. jsonObject.remove(KEY_NAME))
-	 * after getting the value
+	 * after getting the value, or use the utility methods in this class.  This 
+	 * is used more as a testing tool/sanity test than anything else as there 
+	 * are some instances in where keys are returned, however are not listed in 
+	 * the documentation.
+	 * 
+	 * {@link BaseB2Response#readInt(String)}
+	 * {@link BaseB2Response#readLong(String)}
+	 * {@link BaseB2Response#readString(String)}
+	 * {@link BaseB2Response#readObject(String)}
 	 *
 	 * @param LOGGER     The logger to use
 	 */