fixed javadoc

Author: synapticloop

src/main/java/synapticloop/b2/B2ApiClient.java

@@ -1,5 +1,11 @@
 package synapticloop.b2;
 
+import java.io.File;
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.List;
+import java.util.Map;
+
 /*
  * Copyright (c) 2016 Synapticloop.
  * 
@@ -20,17 +26,45 @@
 import org.apache.http.HttpEntity;
 import org.apache.http.impl.client.CloseableHttpClient;
 import org.apache.http.impl.client.HttpClients;
+
 import synapticloop.b2.exception.B2ApiException;
-import synapticloop.b2.request.*;
-import synapticloop.b2.response.*;
+import synapticloop.b2.request.B2AuthorizeAccountRequest;
+import synapticloop.b2.request.B2CancelLargeFileRequest;
+import synapticloop.b2.request.B2CreateBucketRequest;
+import synapticloop.b2.request.B2DeleteBucketRequest;
+import synapticloop.b2.request.B2DeleteFileVersionRequest;
+import synapticloop.b2.request.B2DownloadFileByIdRequest;
+import synapticloop.b2.request.B2DownloadFileByNameRequest;
+import synapticloop.b2.request.B2FinishLargeFileRequest;
+import synapticloop.b2.request.B2GetFileInfoRequest;
+import synapticloop.b2.request.B2GetUploadPartUrlRequest;
+import synapticloop.b2.request.B2GetUploadUrlRequest;
+import synapticloop.b2.request.B2HeadFileByIdRequest;
+import synapticloop.b2.request.B2HideFileRequest;
+import synapticloop.b2.request.B2ListBucketsRequest;
+import synapticloop.b2.request.B2ListFileNamesRequest;
+import synapticloop.b2.request.B2ListFileVersionsRequest;
+import synapticloop.b2.request.B2ListPartsRequest;
+import synapticloop.b2.request.B2ListUnfinishedLargeFilesRequest;
+import synapticloop.b2.request.B2StartLargeFileRequest;
+import synapticloop.b2.request.B2UpdateBucketRequest;
+import synapticloop.b2.request.B2UploadFileRequest;
+import synapticloop.b2.request.B2UploadPartRequest;
+import synapticloop.b2.response.B2AuthorizeAccountResponse;
+import synapticloop.b2.response.B2BucketResponse;
+import synapticloop.b2.response.B2DeleteFileVersionResponse;
+import synapticloop.b2.response.B2DownloadFileResponse;
+import synapticloop.b2.response.B2FileResponse;
+import synapticloop.b2.response.B2FinishLargeFileResponse;
+import synapticloop.b2.response.B2GetUploadPartUrlResponse;
+import synapticloop.b2.response.B2GetUploadUrlResponse;
+import synapticloop.b2.response.B2HideFileResponse;
+import synapticloop.b2.response.B2ListFilesResponse;
+import synapticloop.b2.response.B2ListPartsResponse;
+import synapticloop.b2.response.B2StartLargeFileResponse;
+import synapticloop.b2.response.B2UploadPartResponse;
 import synapticloop.b2.util.ChecksumHelper;
 
-import java.io.File;
-import java.io.IOException;
-import java.io.InputStream;
-import java.util.List;
-import java.util.Map;
-
 /**
  * This is a wrapper class for the underlying calls to the request/response
  * classes.
@@ -359,8 +393,11 @@ public B2FileResponse uploadFile(String bucketId, String fileName, File file) th
 	 *                 see <a href="https://www.backblaze.com/b2/docs/content-types.html">https://www.backblaze.com/b2/docs/content-types.html</a>
 	 *                 for a list of content type mappings.
 	 * @param fileInfo the file info map which will be set as 'X-Bz-Info-' headers
+	 * 
 	 * @return The unique identifier for the file
+	 * 
 	 * @throws B2ApiException if there was an error uploading the file
+	 * @throws IOException if there was an error with the underlying transport
 	 */
 	public B2StartLargeFileResponse startLargeFileUpload(String bucketId, String fileName, String mimeType, Map<String, String> fileInfo) throws B2ApiException, IOException {
 		return new B2StartLargeFileRequest(client, b2AuthorizeAccountResponse, bucketId, fileName, mimeType, fileInfo).getResponse();
@@ -370,8 +407,11 @@ public B2StartLargeFileResponse startLargeFileUpload(String bucketId, String fil
 	 * Cancel large file upload
 	 *
 	 * @param fileId The ID returned by b2_start_large_file.
+	 * 
 	 * @return File response
+	 * 
 	 * @throws B2ApiException if there was an error canceling the upload
+	 * @throws IOException if there was an error with the underlying transport
 	 */
 	public B2FileResponse cancelLargeFileUpload(String fileId) throws B2ApiException, IOException {
 		return new B2CancelLargeFileRequest(client, b2AuthorizeAccountResponse, fileId).getResponse();
@@ -381,8 +421,12 @@ public B2FileResponse cancelLargeFileUpload(String fileId) throws B2ApiException
 	 * Finish large file upload. Converts the parts that have been uploaded into a single B2 file.
 	 *
 	 * @param fileId The ID returned by b2_start_large_file.
+	 * @param partSha1Array the array of sha1 sums for each of the parts in order
+	 * 
 	 * @return File response
+	 * 
 	 * @throws B2ApiException if there was an error finishing the upload
+	 * @throws IOException    if there was an error communicating with the API service
 	 */
 	public B2FinishLargeFileResponse finishLargeFileUpload(String fileId, String[] partSha1Array) throws B2ApiException, IOException {
 		return new B2FinishLargeFileRequest(client, b2AuthorizeAccountResponse, fileId, partSha1Array).getResponse();
@@ -395,20 +439,27 @@ public B2FinishLargeFileResponse finishLargeFileUpload(String fileId, String[] p
 	 * @param partNumber   A number from 1 to 10000. The parts uploaded for one file must have contiguous numbers, starting with 1.
 	 * @param entity       Part content body
 	 * @param sha1Checksum the checksum for the part
+	 * 
 	 * @return Upload response
+	 * 
 	 * @throws B2ApiException if there was an error uploading the file
+	 * @throws IOException    if there was an error communicating with the API service
 	 */
 	public B2UploadPartResponse uploadLargeFilePart(String fileId, int partNumber, HttpEntity entity, String sha1Checksum) throws B2ApiException, IOException {
 		final B2GetUploadPartUrlResponse b2GetUploadUrlResponse = new B2GetUploadPartUrlRequest(client, b2AuthorizeAccountResponse, fileId).getResponse();
 		return new B2UploadPartRequest(client, b2AuthorizeAccountResponse, b2GetUploadUrlResponse, partNumber, entity, sha1Checksum).getResponse();
 	}
 
 	/**
-	 * Lists information about large file uploads that have been started, but have not been finished or canceled.
+	 * Lists information about large file uploads that have been started, but have not been finished or cancelled.
 	 * Uploads are listed in the order they were started, with the oldest one first
 	 *
 	 * @param bucketId the id of the bucket
+	 * @param startFileId the start fileId to list from
+	 * @param maxFileCount the maximum number of files to return
+	 * 
 	 * @return An array of objects, each one describing one unfinished file
+	 * 
 	 * @throws B2ApiException if there was an error listing the files
 	 * @throws IOException    if there was an error communicating with the API service
 	 */
@@ -420,7 +471,9 @@ public B2ListFilesResponse listUnfinishedLargeFiles(String bucketId, String star
 	 * @param fileId          The ID returned by b2_start_large_file. This is the file whose parts will be listed.
 	 * @param startPartNumber Null to start
 	 * @param maxPartCount    The maximum number of parts to return
+	 * 
 	 * @return This call returns at most 1000 entries, but it can be called repeatedly to scan through all of the parts for an upload.
+	 * 
 	 * @throws B2ApiException if there was an error listing the parts
 	 * @throws IOException    if there was an error communicating with the API service
 	 */

src/main/java/synapticloop/b2/exception/B2ApiException.java

@@ -71,6 +71,8 @@ private void parse(String json) {
 
 	/**
 	 * @param retry Value in seconds
+	 * 
+	 * @return the exception with retry
 	 */
 	public B2ApiException withRetry(Integer retry) {
 		this.retry = retry;
@@ -118,6 +120,7 @@ public int getStatus() {
 
 	/**
 	 * Retry-After header value (in seconds)
+	 * 
 	 * @return Value in seconds or null if not Retry-After header in response
 	 */
 	public Integer getRetry() {

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

@@ -1,7 +1,5 @@
 package synapticloop.b2.request;
 
-import java.io.IOException;
-
 /*
  * Copyright (c) 2016 Synapticloop.
  * 
@@ -18,6 +16,8 @@
  * this source code or binaries.
  */
 
+import java.io.IOException;
+
 import org.apache.http.impl.client.CloseableHttpClient;
 import org.apache.http.util.EntityUtils;
 

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

@@ -1,7 +1,5 @@
 package synapticloop.b2.request;
 
-import java.io.IOException;
-
 /*
  * Copyright (c) 2016 Synapticloop.
  * 
@@ -18,6 +16,8 @@
  * this source code or binaries.
  */
 
+import java.io.IOException;
+
 import org.apache.http.HttpHeaders;
 import org.apache.http.impl.client.CloseableHttpClient;
 

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

@@ -1,7 +1,5 @@
 package synapticloop.b2.request;
 
-import java.io.IOException;
-
 /*
  * Copyright (c) 2016 Synapticloop.
  * 
@@ -18,6 +16,8 @@
  * this source code or binaries.
  */
 
+import java.io.IOException;
+
 import org.apache.http.HttpHeaders;
 import org.apache.http.impl.client.CloseableHttpClient;
 

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

@@ -1,5 +1,7 @@
 package synapticloop.b2.request;
 
+import java.io.IOException;
+
 /*
  * Copyright (c) 2016 iterate GmbH.
  * 
@@ -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.B2GetUploadPartUrlResponse;
 
-import java.io.IOException;
-
 public class B2GetUploadPartUrlRequest extends BaseB2Request {
 	private static final String B2_GET_UPLOAD_URL = BASE_API_VERSION + "b2_get_upload_part_url";
 
@@ -47,6 +48,7 @@ public B2GetUploadPartUrlRequest(CloseableHttpClient client, B2AuthorizeAccountR
 	 * @return the upload url response
 	 * 
 	 * @throws B2ApiException if something went wrong
+	 * @throws IOException    if there was an error communicating with the API service
 	 */
 	public B2GetUploadPartUrlResponse getResponse() throws B2ApiException, IOException {
 		return new B2GetUploadPartUrlResponse(EntityUtils.toString(executePost().getEntity()));

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

@@ -1,7 +1,5 @@
 package synapticloop.b2.request;
 
-import java.io.IOException;
-
 /*
  * Copyright (c) 2016 Synapticloop.
  * 
@@ -18,6 +16,8 @@
  * this source code or binaries.
  */
 
+import java.io.IOException;
+
 import org.apache.http.impl.client.CloseableHttpClient;
 
 import synapticloop.b2.exception.B2ApiException;

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

@@ -1,7 +1,5 @@
 package synapticloop.b2.request;
 
-import java.io.IOException;
-
 /*
  * Copyright (c) 2016 Synapticloop.
  * 
@@ -18,6 +16,8 @@
  * this source code or binaries.
  */
 
+import java.io.IOException;
+
 import org.apache.http.impl.client.CloseableHttpClient;
 import org.apache.http.util.EntityUtils;
 

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

@@ -1,5 +1,8 @@
 package synapticloop.b2.request;
 
+import java.io.IOException;
+import java.util.Map;
+
 /*
  * Copyright (c) 2016 iterate GmbH.
  *
@@ -20,15 +23,13 @@
 import org.apache.http.util.EntityUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+
 import synapticloop.b2.exception.B2ApiException;
 import synapticloop.b2.response.B2AuthorizeAccountResponse;
 import synapticloop.b2.response.B2ResponseHeaders;
 import synapticloop.b2.response.B2StartLargeFileResponse;
 import synapticloop.b2.util.URLEncoder;
 
-import java.io.IOException;
-import java.util.Map;
-
 public class B2StartLargeFileRequest extends BaseB2Request {
 	private static final Logger LOGGER = LoggerFactory.getLogger(B2StartLargeFileRequest.class);
 
@@ -38,13 +39,16 @@ public class B2StartLargeFileRequest extends BaseB2Request {
 	/**
 	 * Create a new B2 Start large file request
 	 *
+	 * @param client the HTTP client to use
 	 * @param b2AuthorizeAccountResponse the authorise account response
 	 * @param bucketId                   the id of the bucket to upload to
 	 * @param fileName                   the name of the file
 	 * @param mimeType                   the mimeType (optional, will default to 'b2/x-auto' which
 	 *                                   backblaze will attempt to determine automatically)
 	 * @param fileInfo                   the file info map which are passed through as key value
 	 *                                   pairs in a jsonObject named 'fileInfo'
+	 *
+	 * @throws B2ApiException if something went wrong
 	 */
 	public B2StartLargeFileRequest(CloseableHttpClient client, B2AuthorizeAccountResponse b2AuthorizeAccountResponse,
 								   String bucketId, String fileName,
@@ -58,15 +62,23 @@ public B2StartLargeFileRequest(CloseableHttpClient client, B2AuthorizeAccountRes
 		} else {
 			this.addProperty(B2RequestProperties.KEY_CONTENT_TYPE, mimeType);
 		}
+
 		// Add 'X-Bz-Info-*' headers
 		if (null != fileInfo) {
-			int fileInfoSize = fileInfo.size();
 			for (final String key : fileInfo.keySet()) {
 				this.addHeader(B2ResponseHeaders.HEADER_X_BZ_INFO_PREFIX + URLEncoder.encode(key), URLEncoder.encode(fileInfo.get(key)));
 			}
 		}
 	}
 
+	/**
+	 * Return the start large file response 
+	 * 
+	 * @return the start large file response
+	 * 
+	 * @throws B2ApiException if something went wrong
+	 * @throws IOException    if there was an error communicating with the API service
+	 */
 	public B2StartLargeFileResponse getResponse() throws B2ApiException, IOException {
 		return new B2StartLargeFileResponse(EntityUtils.toString(executePost().getEntity()));
 	}

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

@@ -1,12 +1,5 @@
 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.
  * 
@@ -23,6 +16,13 @@
  * this source code or binaries.
  */
 
+import java.io.IOException;
+import java.net.URI;
+import java.net.URISyntaxException;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Map;
+
 import org.apache.http.HttpEntity;
 import org.apache.http.HttpHeaders;
 import org.apache.http.HttpStatus;