javadoc fix

Synapticloop · Synapticloop · commit a6b4e5770a48 · 2016-03-08T14:34:17.000Z
diff --git a/src/main/java/synapticloop/b2/B2ApiClient.java b/src/main/java/synapticloop/b2/B2ApiClient.java
diff --git a/src/main/java/synapticloop/b2/request/B2AuthorizeAccountRequest.java b/src/main/java/synapticloop/b2/request/B2AuthorizeAccountRequest.java
@@ -71,6 +71,7 @@ public B2AuthorizeAccountRequest(CloseableHttpClient client, String accountId,
 	 * @return the authorize response
 	 * 
 	 * @throws B2ApiException if there was an error with the call
+	 * @throws IOException if there was an error communicating with the API service
 	 */
 	public B2AuthorizeAccountResponse getResponse() throws B2ApiException, IOException {
 		final CloseableHttpResponse httpResponse = executeGet();
diff --git a/src/main/java/synapticloop/b2/request/B2CreateBucketRequest.java b/src/main/java/synapticloop/b2/request/B2CreateBucketRequest.java
@@ -71,6 +71,7 @@ public B2CreateBucketRequest(CloseableHttpClient client, B2AuthorizeAccountRespo
 	 * @return the created bucket response
 	 * 
 	 * @throws B2ApiException if there was an error with the call
+	 * @throws IOException if there was an error communicating with the API service
 	 */
 	public B2BucketResponse getResponse() throws B2ApiException, IOException {
 		return new B2BucketResponse(EntityUtils.toString(executePost().getEntity()));
diff --git a/src/main/java/synapticloop/b2/request/B2DeleteBucketRequest.java b/src/main/java/synapticloop/b2/request/B2DeleteBucketRequest.java
@@ -60,6 +60,7 @@ public B2DeleteBucketRequest(CloseableHttpClient client, B2AuthorizeAccountRespo
 	 * 
 	 * @throws B2ApiException if there was an error with the call, or if you are
 	 *     trying to delete a bucket which is not empty
+	 * @throws IOException if there was an error communicating with the API service
 	 */
 	public B2BucketResponse getResponse() throws B2ApiException, IOException {
 		return new B2BucketResponse(EntityUtils.toString(executePost().getEntity()));
diff --git a/src/main/java/synapticloop/b2/request/B2DeleteFileVersionRequest.java b/src/main/java/synapticloop/b2/request/B2DeleteFileVersionRequest.java
@@ -1,5 +1,7 @@
 package synapticloop.b2.request;
 
+import java.io.IOException;
+
 /*
  * Copyright (c) 2016 synapticloop.
  * 
@@ -18,12 +20,11 @@
 
 import org.apache.http.impl.client.CloseableHttpClient;
 import org.apache.http.util.EntityUtils;
+
 import synapticloop.b2.exception.B2ApiException;
 import synapticloop.b2.response.B2AuthorizeAccountResponse;
 import synapticloop.b2.response.B2DeleteFileVersionResponse;
 
-import java.io.IOException;
-
 /**
  * <p>Deletes one version of a file from B2.</p>
  * 
@@ -65,6 +66,7 @@ public B2DeleteFileVersionRequest(CloseableHttpClient client, B2AuthorizeAccount
 	 * @return the delete file version response
 	 * 
 	 * @throws B2ApiException if there was an error with the call
+	 * @throws IOException if there was an error communicating with the API service
 	 */
 	public B2DeleteFileVersionResponse getResponse() throws B2ApiException, IOException {
 		return new B2DeleteFileVersionResponse(EntityUtils.toString(executePost().getEntity()));
diff --git a/src/main/java/synapticloop/b2/request/B2DownloadFileByIdRequest.java b/src/main/java/synapticloop/b2/request/B2DownloadFileByIdRequest.java
@@ -1,5 +1,7 @@
 package synapticloop.b2.request;
 
+import java.io.IOException;
+
 /*
  * Copyright (c) 2016 synapticloop.
  * 
@@ -23,8 +25,6 @@
 import synapticloop.b2.response.B2AuthorizeAccountResponse;
 import synapticloop.b2.response.B2DownloadFileResponse;
 
-import java.io.IOException;
-
 /**
  * <p>Downloads one file from B2.</p>
  * 
@@ -112,7 +112,9 @@ public B2DownloadFileByIdRequest(CloseableHttpClient client, B2AuthorizeAccountR
 	 * Execute the request and return the response
 	 *
 	 * @return The download file response
+	 * 
 	 * @throws B2ApiException If there was an error with the call
+	 * @throws IOException if there was an error communicating with the API service
 	 */
 	public B2DownloadFileResponse getResponse() throws B2ApiException, IOException {
 		return new B2DownloadFileResponse(executeGet());
diff --git a/src/main/java/synapticloop/b2/request/B2DownloadFileByNameRequest.java b/src/main/java/synapticloop/b2/request/B2DownloadFileByNameRequest.java
@@ -1,5 +1,7 @@
 package synapticloop.b2.request;
 
+import java.io.IOException;
+
 /*
  * Copyright (c) 2016 synapticloop.
  * 
@@ -24,8 +26,6 @@
 import synapticloop.b2.response.B2DownloadFileResponse;
 import synapticloop.b2.util.URLEncoder;
 
-import java.io.IOException;
-
 /**
  * <p>Downloads one file by providing the name of the bucket and the name of the file.</p>
  * 
@@ -92,6 +92,7 @@ public B2DownloadFileByNameRequest(CloseableHttpClient client, B2AuthorizeAccoun
 	 * @return The download file response
 	 * 
 	 * @throws B2ApiException If there was an error with the call
+	 * @throws IOException if there was an error communicating with the API service
 	 */
 	public B2DownloadFileResponse getResponse() throws B2ApiException, IOException {
 		return new B2DownloadFileResponse(executeGet());
diff --git a/src/main/java/synapticloop/b2/request/B2GetFileInfoRequest.java b/src/main/java/synapticloop/b2/request/B2GetFileInfoRequest.java
@@ -61,6 +61,7 @@ public B2GetFileInfoRequest(CloseableHttpClient client, B2AuthorizeAccountRespon
 	 * @return The details for the file information
 	 * 
 	 * @throws B2ApiException if there was an error with the call
+	 * @throws IOException if there was an error communicating with the API service
 	 */
 	public B2FileResponse getResponse() throws B2ApiException, IOException {
 		return new B2FileResponse(EntityUtils.toString(executePost().getEntity()));
diff --git a/src/main/java/synapticloop/b2/request/B2GetUploadUrlRequest.java b/src/main/java/synapticloop/b2/request/B2GetUploadUrlRequest.java
@@ -60,6 +60,7 @@ public B2GetUploadUrlRequest(CloseableHttpClient client, B2AuthorizeAccountRespo
 	 * @return the upload url response
 	 * 
 	 * @throws B2ApiException if something went wrong
+	 * @throws IOException if there was an error communicating with the API service
 	 */
 	public B2GetUploadUrlResponse getResponse() throws B2ApiException, IOException {
 		return new B2GetUploadUrlResponse(EntityUtils.toString(executePost().getEntity()));
diff --git a/src/main/java/synapticloop/b2/request/B2HeadFileByIdRequest.java b/src/main/java/synapticloop/b2/request/B2HeadFileByIdRequest.java
@@ -1,5 +1,7 @@
 package synapticloop.b2.request;
 
+import java.io.IOException;
+
 /*
  * Copyright (c) 2016 synapticloop.
  * 
@@ -22,8 +24,6 @@
 import synapticloop.b2.response.B2AuthorizeAccountResponse;
 import synapticloop.b2.response.B2DownloadFileResponse;
 
-import java.io.IOException;
-
 /**
  * <p>Gets information on one file from B2.</p>
  * 
@@ -77,6 +77,7 @@ public B2HeadFileByIdRequest(CloseableHttpClient client, B2AuthorizeAccountRespo
 	 * @return the download file response - note that this does not contain any body content
 	 * 
 	 * @throws B2ApiException if something went wrong
+	 * @throws IOException if there was an error communicating with the API service
 	 */
 	public B2DownloadFileResponse getResponse() throws B2ApiException, IOException {
 		return new B2DownloadFileResponse(this.executeHead());
diff --git a/src/main/java/synapticloop/b2/request/B2HideFileRequest.java b/src/main/java/synapticloop/b2/request/B2HideFileRequest.java
@@ -1,5 +1,7 @@
 package synapticloop.b2.request;
 
+import java.io.IOException;
+
 /*
  * Copyright (c) 2016 synapticloop.
  * 
@@ -18,12 +20,11 @@
 
 import org.apache.http.impl.client.CloseableHttpClient;
 import org.apache.http.util.EntityUtils;
+
 import synapticloop.b2.exception.B2ApiException;
 import synapticloop.b2.response.B2AuthorizeAccountResponse;
 import synapticloop.b2.response.B2HideFileResponse;
 
-import java.io.IOException;
-
 /**
  * <p>Hides a file so that downloading by name will not find the file, but previous versions of the file are still stored. See File Versions about what it means to hide a file.</p>
  * 
@@ -58,6 +59,7 @@ public B2HideFileRequest(CloseableHttpClient client, B2AuthorizeAccountResponse
 	 * @return the hide file response
 	 * 
 	 * @throws B2ApiException if something went wrong
+	 * @throws IOException if there was an error communicating with the API service
 	 */
 	public B2HideFileResponse getResponse() throws B2ApiException, IOException {
 		return new B2HideFileResponse(EntityUtils.toString(executePost().getEntity()));
diff --git a/src/main/java/synapticloop/b2/request/B2ListBucketsRequest.java b/src/main/java/synapticloop/b2/request/B2ListBucketsRequest.java
@@ -56,6 +56,7 @@ public B2ListBucketsRequest(CloseableHttpClient client, B2AuthorizeAccountRespon
 	 * @return the list buckets response
 	 * 
 	 * @throws B2ApiException if something went wrong
+	 * @throws IOException if there was an error communicating with the API service
 	 */
 	public B2ListBucketsResponse getResponse() throws B2ApiException, IOException {
 		return new B2ListBucketsResponse(EntityUtils.toString(executePost().getEntity()));
diff --git a/src/main/java/synapticloop/b2/request/B2ListFileNamesRequest.java b/src/main/java/synapticloop/b2/request/B2ListFileNamesRequest.java
@@ -24,7 +24,6 @@
 import synapticloop.b2.exception.B2ApiException;
 import synapticloop.b2.response.B2AuthorizeAccountResponse;
 import synapticloop.b2.response.B2ListFilesResponse;
-import synapticloop.b2.util.URLEncoder;
 
 /**
  * <p>Lists the names of all files in a bucket, starting at a given name.</p>
@@ -100,6 +99,7 @@ public B2ListFileNamesRequest(CloseableHttpClient client, B2AuthorizeAccountResp
 	 * @return the list file names response
 	 * 
 	 * @throws B2ApiException if something went wrong
+	 * @throws IOException if there was an error communicating with the API service
 	 */
 	public B2ListFilesResponse getResponse() throws B2ApiException, IOException {
 		return new B2ListFilesResponse(EntityUtils.toString(executePost().getEntity()));
diff --git a/src/main/java/synapticloop/b2/request/B2ListFileVersionsRequest.java b/src/main/java/synapticloop/b2/request/B2ListFileVersionsRequest.java
@@ -24,7 +24,6 @@
 import synapticloop.b2.exception.B2ApiException;
 import synapticloop.b2.response.B2AuthorizeAccountResponse;
 import synapticloop.b2.response.B2ListFilesResponse;
-import synapticloop.b2.util.URLEncoder;
 
 /**
  * <p>Lists all of the versions of all of the files contained in one bucket, in 
@@ -108,6 +107,7 @@ public B2ListFileVersionsRequest(CloseableHttpClient client, B2AuthorizeAccountR
 	 * @return the list file versions response
 	 * 
 	 * @throws B2ApiException if something went wrong
+	 * @throws IOException if there was an error communicating with the API service
 	 */
 	public B2ListFilesResponse getResponse() throws B2ApiException, IOException {
 		return new B2ListFilesResponse(EntityUtils.toString(executePost().getEntity()));
diff --git a/src/main/java/synapticloop/b2/request/B2UpdateBucketRequest.java b/src/main/java/synapticloop/b2/request/B2UpdateBucketRequest.java
@@ -64,6 +64,7 @@ public B2UpdateBucketRequest(CloseableHttpClient client, B2AuthorizeAccountRespo
 	 * @return the bucket response
 	 * 
 	 * @throws B2ApiException if something went wrong
+	 * @throws IOException if there was an error communicating with the API service
 	 */
 	public B2BucketResponse getResponse() throws B2ApiException, IOException {
 		return new B2BucketResponse(EntityUtils.toString(executePost().getEntity()));
diff --git a/src/main/java/synapticloop/b2/request/B2UploadFileRequest.java b/src/main/java/synapticloop/b2/request/B2UploadFileRequest.java
@@ -203,6 +203,7 @@ public B2UploadFileRequest(CloseableHttpClient client, B2AuthorizeAccountRespons
 	 * @return the file response
 	 * 
 	 * @throws B2ApiException if something went wrong
+	 * @throws IOException if there was an error communicating with the API service
 	 */
 
 	public B2FileResponse getResponse() throws B2ApiException, IOException {
diff --git a/src/main/java/synapticloop/b2/request/BaseB2Request.java b/src/main/java/synapticloop/b2/request/BaseB2Request.java
@@ -1,5 +1,12 @@
 package synapticloop.b2.request;
 
+import java.io.IOException;
+import java.net.URI;
+import java.net.URISyntaxException;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Map;
+
 /*
  * Copyright (c) 2016 synapticloop.
  * 
@@ -20,7 +27,11 @@
 import org.apache.http.HttpHeaders;
 import org.apache.http.HttpStatus;
 import org.apache.http.client.HttpResponseException;
-import org.apache.http.client.methods.*;
+import org.apache.http.client.methods.CloseableHttpResponse;
+import org.apache.http.client.methods.HttpGet;
+import org.apache.http.client.methods.HttpHead;
+import org.apache.http.client.methods.HttpPost;
+import org.apache.http.client.methods.HttpUriRequest;
 import org.apache.http.client.utils.URIBuilder;
 import org.apache.http.entity.StringEntity;
 import org.apache.http.impl.client.CloseableHttpClient;
@@ -29,16 +40,10 @@
 import org.json.JSONObject;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+
 import synapticloop.b2.exception.B2ApiException;
 import synapticloop.b2.response.B2AuthorizeAccountResponse;
 
-import java.io.IOException;
-import java.net.URI;
-import java.net.URISyntaxException;
-import java.util.Collections;
-import java.util.HashMap;
-import java.util.Map;
-
 public abstract class BaseB2Request {
 	private static final Logger LOGGER = LoggerFactory.getLogger(BaseB2Request.class);
 
@@ -142,6 +147,7 @@ protected void addProperty(String key, Object value) {
 	 * @return the response object
 	 * 
 	 * @throws B2ApiException if something went wrong with the call
+	 * @throws IOException if there was an error communicating with the API service
 	 */
 	protected CloseableHttpResponse executeHead() throws B2ApiException, IOException {
 		URI uri = this.buildUri();
@@ -153,9 +159,10 @@ protected CloseableHttpResponse executeHead() throws B2ApiException, IOException
 		CloseableHttpResponse httpResponse = this.execute(httpHead);
 
 		switch(httpResponse.getStatusLine().getStatusCode()) {
-			case HttpStatus.SC_OK:
-				return httpResponse;
+		case HttpStatus.SC_OK:
+			return httpResponse;
 		}
+
 		throw new B2ApiException(EntityUtils.toString(httpResponse.getEntity()), new HttpResponseException(
 				httpResponse.getStatusLine().getStatusCode(), httpResponse.getStatusLine().getReasonPhrase()));
 	}
@@ -166,6 +173,7 @@ protected CloseableHttpResponse executeHead() throws B2ApiException, IOException
 	 * @return The response from the GET request
 	 *
 	 * @throws B2ApiException if there was an error with the request
+	 * @throws IOException if there was an error communicating with the API service
 	 */
 	protected CloseableHttpResponse executeGet() throws B2ApiException, IOException {
 		URI uri = this.buildUri();
@@ -176,10 +184,11 @@ protected CloseableHttpResponse executeGet() throws B2ApiException, IOException
 
 		// you will either get an OK or a partial content
 		switch(httpResponse.getStatusLine().getStatusCode()) {
-			case HttpStatus.SC_OK:
-			case HttpStatus.SC_PARTIAL_CONTENT:
-				return httpResponse;
+		case HttpStatus.SC_OK:
+		case HttpStatus.SC_PARTIAL_CONTENT:
+			return httpResponse;
 		}
+
 		throw new B2ApiException(EntityUtils.toString(httpResponse.getEntity()), new HttpResponseException(
 				httpResponse.getStatusLine().getStatusCode(), httpResponse.getStatusLine().getReasonPhrase()));
 	}
@@ -191,6 +200,7 @@ protected CloseableHttpResponse executeGet() throws B2ApiException, IOException
 	 * 
 	 * @throws B2ApiException if there was an error with the call, most notably
 	 *     a non OK status code (i.e. not 200)
+	 * @throws IOException if there was an error communicating with the API service
 	 */
 	protected CloseableHttpResponse executePost() throws B2ApiException, IOException {
 		URI uri = this.buildUri();
@@ -202,9 +212,10 @@ protected CloseableHttpResponse executePost() throws B2ApiException, IOException
 		CloseableHttpResponse httpResponse = this.execute(httpPost);
 
 		switch(httpResponse.getStatusLine().getStatusCode()) {
-			case HttpStatus.SC_OK:
-				return httpResponse;
+		case HttpStatus.SC_OK:
+			return httpResponse;
 		}
+
 		throw new B2ApiException(EntityUtils.toString(httpResponse.getEntity()), new HttpResponseException(
 				httpResponse.getStatusLine().getStatusCode(), httpResponse.getStatusLine().getReasonPhrase()));
 	}
@@ -218,6 +229,7 @@ protected CloseableHttpResponse executePost() throws B2ApiException, IOException
 	 * 
 	 * @throws B2ApiException if there was an error with the call, most notably
 	 *     a non OK status code (i.e. not 200)
+	 * @throws IOException if there was an error communicating with the API service
 	 */
 	protected CloseableHttpResponse executePost(HttpEntity entity) throws B2ApiException, IOException {
 		URI uri = this.buildUri();
@@ -228,9 +240,10 @@ protected CloseableHttpResponse executePost(HttpEntity entity) throws B2ApiExcep
 		CloseableHttpResponse httpResponse = this.execute(httpPost);
 
 		switch(httpResponse.getStatusLine().getStatusCode()) {
-			case HttpStatus.SC_OK:
-				return httpResponse;
+		case HttpStatus.SC_OK:
+			return httpResponse;
 		}
+
 		throw new B2ApiException(EntityUtils.toString(httpResponse.getEntity()), new HttpResponseException(
 				httpResponse.getStatusLine().getStatusCode(), httpResponse.getStatusLine().getReasonPhrase()));
 	}
@@ -330,5 +343,4 @@ private Object obfuscateData(String key, Object data) {
 		}
 		return(data);
 	}
-
 }
diff --git a/src/main/java/synapticloop/b2/response/B2BucketResponse.java b/src/main/java/synapticloop/b2/response/B2BucketResponse.java
@@ -36,6 +36,7 @@ public class B2BucketResponse extends BaseB2Response {
 	 * the API call.  This response is then parsed into the relevant fields.
 	 *
 	 * @param json The response (in JSON format)
+	 * 
 	 * @throws B2ApiException if there was an error parsing the response
 	 */
 	public B2BucketResponse(String json) throws B2ApiException {
@@ -54,6 +55,7 @@ public B2BucketResponse(String json) throws B2ApiException {
 	 * the API call.  This response is then parsed into the relevant fields.
 	 *
 	 * @param response The pre-parsed jsonObject
+	 * 
 	 * @throws B2ApiException if there was an error parsing the response
 	 */
 	public B2BucketResponse(final JSONObject response) throws B2ApiException {
diff --git a/src/main/java/synapticloop/b2/response/B2DownloadFileResponse.java b/src/main/java/synapticloop/b2/response/B2DownloadFileResponse.java
@@ -73,6 +73,7 @@ public class B2DownloadFileResponse {
 	 * @param response The HTTP response object
 	 * 
 	 * @throws B2ApiException if there was an error parsing the response
+	 * @throws IOException if there was an error communicating with the API service
 	 */
 	public B2DownloadFileResponse(CloseableHttpResponse response) throws B2ApiException, IOException {
 		if(null != response.getEntity()) {

Original file line number	Diff line number	Diff line change
`@@ -71,6 +71,7 @@ public B2AuthorizeAccountRequest(CloseableHttpClient client, String accountId,`
`71`	`71`	`* @return the authorize response`
`72`	`72`	`*`
`73`	`73`	`* @throws B2ApiException if there was an error with the call`
	`74`	`+ * @throws IOException if there was an error communicating with the API service`
`74`	`75`	`*/`
`75`	`76`	`public B2AuthorizeAccountResponse getResponse() throws B2ApiException, IOException {`
`76`	`77`	`final CloseableHttpResponse httpResponse = executeGet();`
Original file line number	Diff line number	Diff line change
`@@ -71,6 +71,7 @@ public B2CreateBucketRequest(CloseableHttpClient client, B2AuthorizeAccountRespo`
`71`	`71`	`* @return the created bucket response`
`72`	`72`	`*`
`73`	`73`	`* @throws B2ApiException if there was an error with the call`
	`74`	`+ * @throws IOException if there was an error communicating with the API service`
`74`	`75`	`*/`
`75`	`76`	`public B2BucketResponse getResponse() throws B2ApiException, IOException {`
`76`	`77`	`return new B2BucketResponse(EntityUtils.toString(executePost().getEntity()));`
Original file line number	Diff line number	Diff line change
`@@ -60,6 +60,7 @@ public B2DeleteBucketRequest(CloseableHttpClient client, B2AuthorizeAccountRespo`
`60`	`60`	`*`
`61`	`61`	`* @throws B2ApiException if there was an error with the call, or if you are`
`62`	`62`	`* trying to delete a bucket which is not empty`
	`63`	`+ * @throws IOException if there was an error communicating with the API service`
`63`	`64`	`*/`
`64`	`65`	`public B2BucketResponse getResponse() throws B2ApiException, IOException {`
`65`	`66`	`return new B2BucketResponse(EntityUtils.toString(executePost().getEntity()));`
Original file line number	Diff line number	Diff line change
`@@ -61,6 +61,7 @@ public B2GetFileInfoRequest(CloseableHttpClient client, B2AuthorizeAccountRespon`
`61`	`61`	`* @return The details for the file information`
`62`	`62`	`*`
`63`	`63`	`* @throws B2ApiException if there was an error with the call`
	`64`	`+ * @throws IOException if there was an error communicating with the API service`
`64`	`65`	`*/`
`65`	`66`	`public B2FileResponse getResponse() throws B2ApiException, IOException {`
`66`	`67`	`return new B2FileResponse(EntityUtils.toString(executePost().getEntity()));`
Original file line number	Diff line number	Diff line change
`@@ -60,6 +60,7 @@ public B2GetUploadUrlRequest(CloseableHttpClient client, B2AuthorizeAccountRespo`
`60`	`60`	`* @return the upload url response`
`61`	`61`	`*`
`62`	`62`	`* @throws B2ApiException if something went wrong`
	`63`	`+ * @throws IOException if there was an error communicating with the API service`
`63`	`64`	`*/`
`64`	`65`	`public B2GetUploadUrlResponse getResponse() throws B2ApiException, IOException {`
`65`	`66`	`return new B2GetUploadUrlResponse(EntityUtils.toString(executePost().getEntity()));`