Merge pull request #5 from synapticloop/iterate-merge

fixed readme and javadoc

Author: synapticloop

README.md

@@ -8,7 +8,8 @@ A Java API for the truly excellent backblaze B2 storage
 String b2AccountId = ""; // your b2 account ID
 String b2ApplicationKey = ""; // your b2 application Key
 
-B2ApiClient b2ApiClient = new B2ApiClient(b2AccountId, b2ApplicationKey);
+B2ApiClient b2ApiClient = new B2ApiClient();
+b2ApiClient.authorize(b2AccountId, b2ApplicationKey);
 
 // now create a private bucket
 B2BucketResponse createPrivateBucket = b2ApiClient.createBucket("super-secret-bucket" , BucketType.ALL_PRIVATE);

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

@@ -77,7 +77,9 @@ public B2ApiClient() {
 
 	/**
 	 * Must authenticate first before API actions are available
-	 *  @param client Shared HTTP client
+	 * 
+	 * @param client Shared HTTP client
+	 * 
 	 * @see #authenticate(String, String)
 	 */
 	public B2ApiClient(CloseableHttpClient client) {
@@ -98,18 +100,29 @@ public B2AuthorizeAccountResponse authenticate(String accountId, String applicat
 		return b2AuthorizeAccountResponse = new B2AuthorizeAccountRequest(client, accountId, applicationKey).getResponse();
 	}
 
+	/**
+	 * Get the download URL for the authorized response
+	 * 
+	 * @return the download URL for the authorized response
+	 */
 	public String getDownloadUrl() {
 		return b2AuthorizeAccountResponse.getDownloadUrl();
 	}
 
+	/**
+	 * Get the API url 
+	 * 
+	 * @return the API URL for backblaze
+	 */
 	public String getApiUrl() {
 		return b2AuthorizeAccountResponse.getApiUrl();
 	}
 
-    /**
-     * Release all resources from the connection pool.
-     * @throws IOException
-     */
+	/**
+	 * Release all resources from the connection pool.
+	 * 
+	 * @throws IOException if the client could not be closed
+	 */
 	public void close() throws IOException {
 		client.close();
 	}
@@ -264,6 +277,7 @@ public B2DownloadFileResponse headFileById(String fileId) throws B2ApiException
 	 * @param fileName the name of the file that will be placed in the bucket
 	 *     (including any path separators '/')
 	 * @param entity the file content to upload
+	 * @param sha1Checksum the checksum for the file
 	 * @param mimeType the mime type of the file, if null, then the mime type
 	 *     will be attempted to be automatically mapped by the backblaze B2 API
 	 *     see <a href="https://www.backblaze.com/b2/docs/content-types.html">https://www.backblaze.com/b2/docs/content-types.html</a>
@@ -389,7 +403,7 @@ public B2DeleteFileVersionResponse deleteFileVersion(String fileName, String fil
 	 * @return The hide response
 	 *
 	 * @throws B2ApiException if there was an error hiding the file
-     */
+	 */
 	public B2HideFileResponse hideFile(String bucketId, String fileName) throws B2ApiException {
 		return new B2HideFileRequest(client, b2AuthorizeAccountResponse, bucketId, fileName).getResponse();
 	}

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

@@ -60,6 +60,8 @@ public class B2UploadFileRequest extends BaseB2Request {
 	 * @param fileName the name of the file
 	 * @param file the file to upload
 	 * @param fileInfo the file info map which are passed through as headers prefixed by "X-Bz-Info-"
+	 * 
+	 * @throws B2ApiException if there was an error in the request
 	 */
 	public B2UploadFileRequest(CloseableHttpClient client, B2AuthorizeAccountResponse b2AuthorizeAccountResponse, 
 			B2GetUploadUrlResponse b2GetUploadUrlResponse, String fileName, File file, Map<String, String> fileInfo) throws B2ApiException {
@@ -78,6 +80,8 @@ public B2UploadFileRequest(CloseableHttpClient client, B2AuthorizeAccountRespons
 	 * @param file the file to upload
 	 * @param mimeType the mimeTyp (optional, will default to 'b2/x-auto' which
 	 *     backblaze will attempt to determine automatically)
+	 * 
+	 * @throws B2ApiException if there was an error in the request
 	 */
 	public B2UploadFileRequest(CloseableHttpClient client, B2AuthorizeAccountResponse b2AuthorizeAccountResponse, 
 			B2GetUploadUrlResponse b2GetUploadUrlResponse, String fileName, File file, String mimeType) throws B2ApiException {
@@ -94,12 +98,11 @@ public B2UploadFileRequest(CloseableHttpClient client, B2AuthorizeAccountRespons
 	 * @param b2GetUploadUrlResponse the upload URL for this request
 	 * @param fileName the name of the file
 	 * @param file the file to upload
+	 * 
+	 * @throws B2ApiException if there was an error in the request
 	 */
-	public B2UploadFileRequest(CloseableHttpClient client, 
-			B2AuthorizeAccountResponse b2AuthorizeAccountResponse,
-			B2GetUploadUrlResponse b2GetUploadUrlResponse, 
-			String fileName, 
-			File file) throws B2ApiException {
+	public B2UploadFileRequest(CloseableHttpClient client, B2AuthorizeAccountResponse b2AuthorizeAccountResponse,
+			B2GetUploadUrlResponse b2GetUploadUrlResponse, String fileName, File file) throws B2ApiException {
 
 		this(client, b2AuthorizeAccountResponse, b2GetUploadUrlResponse, fileName, file, null, null);
 	}
@@ -117,13 +120,11 @@ public B2UploadFileRequest(CloseableHttpClient client,
 	 *     backblaze will attempt to determine automatically)
 	 * @param fileInfo the file info map which are passed through as headers
 	 *     prefixed by "X-Bz-Info-"
+	 * 
+	 * @throws B2ApiException if there was an error in the request
 	 */
-	public B2UploadFileRequest(CloseableHttpClient client, 
-			B2AuthorizeAccountResponse b2AuthorizeAccountResponse, 
-			B2GetUploadUrlResponse b2GetUploadUrlResponse, 
-			String fileName, 
-			File file, 
-			String mimeType, 
+	public B2UploadFileRequest(CloseableHttpClient client, B2AuthorizeAccountResponse b2AuthorizeAccountResponse, 
+			B2GetUploadUrlResponse b2GetUploadUrlResponse, String fileName, File file, String mimeType, 
 			Map<String, String> fileInfo) throws B2ApiException {
 
 		this(client, 

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

@@ -274,7 +274,9 @@ protected URI buildUri() throws URISyntaxException {
 	 * To override what headers are set, this should be done in the constructor
 	 * of the base request object.
 	 * 
-	 * @param request The http request to set the headers on
+	 * @param request The HTTP request to set the headers on
+	 * 
+	 * @throws B2ApiException if there was an error setting the headers
 	 */
 	protected void setHeaders(HttpUriRequest request) throws B2ApiException {
 		for (String headerKey : requestHeaders.keySet()) {

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

@@ -61,7 +61,7 @@ public B2BucketResponse(String json) throws B2ApiException {
 	 * Instantiate a bucket response with the JSON response as a string from 
 	 * the API call.  This response is then parsed into the relevant fields.
 	 * 
-	 * @param JSONObject The pre-parsed jsonObject
+	 * @param response The pre-parsed jsonObject
 	 * 
 	 * @throws B2ApiException if there was an error parsing the response
 	 */

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

@@ -41,7 +41,7 @@ public BaseB2Response(final String json) throws B2ApiException {
 	/**
 	 * Create a new B2 Response with a pre parsed JSONObject response
 	 * 
-	 * @param responsem the pre-parsed json object
+	 * @param response the pre-parsed json object
 	 * 
 	 * @throws B2ApiException if there was an error in the response
 	 */