Merge pull request #494 from mziccard/storage-minor

Remove RemoteGcsHelper.create(String, String) and other minor fixes

TESTING.md

@@ -55,7 +55,8 @@ Currently, there isn't an emulator for Google Cloud Storage, so an alternative i
 3. Create a `RemoteGcsHelper` object using your project ID and JSON key.
 Here is an example that uses the `RemoteGcsHelper` to create a bucket.
   ```java
-  RemoteGcsHelper gcsHelper = RemoteGcsHelper.create(PROJECT_ID, "/path/to/my/JSON/key.json");
+  RemoteGcsHelper gcsHelper =
+      RemoteGcsHelper.create(PROJECT_ID, new FileInputStream("/path/to/my/JSON/key.json"));
   Storage storage = gcsHelper.options().service();
   String bucket = RemoteGcsHelper.generateBucketName();
   storage.create(BucketInfo.of(bucket));

gcloud-java-storage/src/main/java/com/google/gcloud/spi/DefaultStorageRpc.java

@@ -479,8 +479,8 @@ public Tuple<String, byte[]> read(StorageObject from, Map<Option, ?> options, lo
   }
 
   @Override
-  public void write(String uploadId, byte[] toWrite, int toWriteOffset, StorageObject dest,
-      long destOffset, int length, boolean last) throws StorageException {
+  public void write(String uploadId, byte[] toWrite, int toWriteOffset, long destOffset, int length,
+      boolean last) throws StorageException {
     try {
       GenericUrl url = new GenericUrl(uploadId);
       HttpRequest httpRequest = storage.getRequestFactory().buildPutRequest(url,
@@ -571,7 +571,7 @@ private RewriteResponse rewrite(RewriteRequest req, String token) throws Storage
     try {
       Long maxBytesRewrittenPerCall = req.megabytesRewrittenPerCall != null
           ? req.megabytesRewrittenPerCall * MEGABYTE : null;
-      com.google.api.services.storage.model.RewriteResponse rewriteReponse = storage.objects()
+      com.google.api.services.storage.model.RewriteResponse rewriteResponse = storage.objects()
           .rewrite(req.source.getBucket(), req.source.getName(), req.target.getBucket(),
               req.target.getName(), req.target.getContentType() != null ? req.target : null)
           .setSourceGeneration(req.source.getGeneration())
@@ -590,11 +590,11 @@ private RewriteResponse rewrite(RewriteRequest req, String token) throws Storage
           .execute();
       return new RewriteResponse(
           req,
-          rewriteReponse.getResource(),
-          rewriteReponse.getObjectSize().longValue(),
-          rewriteReponse.getDone(),
-          rewriteReponse.getRewriteToken(),
-          rewriteReponse.getTotalBytesRewritten().longValue());
+          rewriteResponse.getResource(),
+          rewriteResponse.getObjectSize().longValue(),
+          rewriteResponse.getDone(),
+          rewriteResponse.getRewriteToken(),
+          rewriteResponse.getTotalBytesRewritten().longValue());
     } catch (IOException ex) {
       throw translate(ex);
     }

gcloud-java-storage/src/main/java/com/google/gcloud/spi/StorageRpc.java

@@ -264,8 +264,8 @@ Tuple<String, byte[]> read(StorageObject from, Map<Option, ?> options, long posi
 
   String open(StorageObject object, Map<Option, ?> options) throws StorageException;
 
-  void write(String uploadId, byte[] toWrite, int toWriteOffset, StorageObject dest,
-      long destOffset, int length, boolean last) throws StorageException;
+  void write(String uploadId, byte[] toWrite, int toWriteOffset, long destOffset, int length,
+      boolean last) throws StorageException;
 
   RewriteResponse openRewrite(RewriteRequest rewriteRequest) throws StorageException;
 

gcloud-java-storage/src/main/java/com/google/gcloud/storage/Acl.java

@@ -73,14 +73,14 @@ protected String value() {
     }
 
     @Override
-    public boolean equals(Object o) {
-      if (this == o) {
+    public boolean equals(Object obj) {
+      if (this == obj) {
         return true;
       }
-      if (o == null || getClass() != o.getClass()) {
+      if (obj == null || getClass() != obj.getClass()) {
         return false;
       }
-      Entity entity = (Entity) o;
+      Entity entity = (Entity) obj;
       return Objects.equals(type, entity.type) && Objects.equals(value, entity.value);
     }
 
@@ -226,7 +226,7 @@ public static final class Project extends Entity {
 
     private static final long serialVersionUID = 7933776866530023027L;
 
-    private final ProjectRole pRole;
+    private final ProjectRole projectRole;
     private final String projectId;
 
     public enum ProjectRole {
@@ -236,20 +236,20 @@ public enum ProjectRole {
     /**
      * Creates a project entity.
      *
-     * @param pRole a role in the project, used to select project's teams
+     * @param projectRole a role in the project, used to select project's teams
      * @param projectId id of the project
      */
-    public Project(ProjectRole pRole, String projectId) {
-      super(Type.PROJECT, pRole.name().toLowerCase() + "-" + projectId);
-      this.pRole = pRole;
+    public Project(ProjectRole projectRole, String projectId) {
+      super(Type.PROJECT, projectRole.name().toLowerCase() + "-" + projectId);
+      this.projectRole = projectRole;
       this.projectId = projectId;
     }
 
     /**
      * Returns the role in the project for this entity.
      */
     public ProjectRole projectRole() {
-      return pRole;
+      return projectRole;
     }
 
     /**
@@ -275,7 +275,7 @@ String toPb() {
   }
 
   /**
-   * Creats an ACL object.
+   * Creates an ACL object.
    *
    * @param entity the entity for this ACL object
    * @param role the role to associate to the {@code entity} object

gcloud-java-storage/src/main/java/com/google/gcloud/storage/BatchResponse.java

@@ -113,7 +113,7 @@ static <T extends Serializable> Result<T> empty() {
     }
   }
 
-  public BatchResponse(List<Result<Boolean>> deleteResult, List<Result<BlobInfo>> updateResult,
+  BatchResponse(List<Result<Boolean>> deleteResult, List<Result<BlobInfo>> updateResult,
       List<Result<BlobInfo>> getResult) {
     this.deleteResult = ImmutableList.copyOf(deleteResult);
     this.updateResult = ImmutableList.copyOf(updateResult);

gcloud-java-storage/src/main/java/com/google/gcloud/storage/Blob.java

@@ -39,8 +39,7 @@
 /**
  * A Google cloud storage object.
  *
- * <p>
- * Objects of this class are immutable. Operations that modify the blob like {@link #update} and
+ * <p>Objects of this class are immutable. Operations that modify the blob like {@link #update} and
  * {@link #copyTo} return a new object. To get a {@code Blob} object with the most recent
  * information use {@link #reload}.
  * </p>
@@ -239,13 +238,13 @@ public Blob reload(BlobSourceOption... options) {
    * made on the metadata generation of the current blob. If you want to update the information only
    * if the current blob metadata are at their latest version use the {@code metagenerationMatch}
    * option: {@code blob.update(newInfo, BlobTargetOption.metagenerationMatch())}.
-   * <p>
-   * Original metadata are merged with metadata in the provided {@code blobInfo}. To replace
+   *
+   * <p>Original metadata are merged with metadata in the provided {@code blobInfo}. To replace
    * metadata instead you first have to unset them. Unsetting metadata can be done by setting the
    * provided {@code blobInfo}'s metadata to {@code null}.
    * </p>
-   * <p>
-   * Example usage of replacing blob's metadata:
+   *
+   * <p>Example usage of replacing blob's metadata:
    * <pre>    {@code blob.update(blob.info().toBuilder().metadata(null).build());}
    *    {@code blob.update(blob.info().toBuilder().metadata(newMetadata).build());}
    * </pre>
@@ -261,6 +260,17 @@ public Blob update(BlobInfo blobInfo, BlobTargetOption... options) {
     return new Blob(storage, storage.update(blobInfo, options));
   }
 
+  /**
+   * Deletes this blob.
+   *
+   * @param options blob delete options
+   * @return {@code true} if blob was deleted, {@code false} if it was not found
+   * @throws StorageException upon failure
+   */
+  public boolean delete(BlobSourceOption... options) {
+    return storage.delete(info.blobId(), toSourceOptions(info, options));
+  }
+
   /**
    * Sends a copy request for the current blob to the target blob. Possibly also some of the
    * metadata are copied (e.g. content-type).
@@ -277,17 +287,6 @@ public CopyWriter copyTo(BlobId targetBlob, BlobSourceOption... options) {
     return storage.copy(copyRequest);
   }
 
-  /**
-   * Deletes this blob.
-   *
-   * @param options blob delete options
-   * @return {@code true} if blob was deleted, {@code false} if it was not found
-   * @throws StorageException upon failure
-   */
-  public boolean delete(BlobSourceOption... options) {
-    return storage.delete(info.blobId(), toSourceOptions(info, options));
-  }
-
   /**
    * Sends a copy request for the current blob to the target bucket, preserving its name. Possibly
    * copying also some of the metadata (e.g. content-type).
@@ -381,8 +380,8 @@ public static List<Blob> get(final Storage storage, BlobId... blobs) {
     return Collections.unmodifiableList(Lists.transform(storage.get(blobs),
         new Function<BlobInfo, Blob>() {
           @Override
-          public Blob apply(BlobInfo f) {
-            return f != null ? new Blob(storage, f) : null;
+          public Blob apply(BlobInfo blobInfo) {
+            return blobInfo != null ? new Blob(storage, blobInfo) : null;
           }
         }));
   }
@@ -410,8 +409,8 @@ public static List<Blob> update(final Storage storage, BlobInfo... infos) {
     return Collections.unmodifiableList(Lists.transform(storage.update(infos),
         new Function<BlobInfo, Blob>() {
           @Override
-          public Blob apply(BlobInfo f) {
-            return f != null ? new Blob(storage, f) : null;
+          public Blob apply(BlobInfo blobInfo) {
+            return blobInfo != null ? new Blob(storage, blobInfo) : null;
           }
         }));
   }

gcloud-java-storage/src/main/java/com/google/gcloud/storage/BlobInfo.java

@@ -277,7 +277,7 @@ Builder mediaLink(String mediaLink) {
      */
     public Builder metadata(Map<String, String> metadata) {
       this.metadata = metadata != null
-          ? new HashMap(metadata) : Data.<Map>nullOf(ImmutableEmptyMap.class);
+          ? new HashMap<>(metadata) : Data.<Map<String, String>>nullOf(ImmutableEmptyMap.class);
       return this;
     }
 
@@ -576,8 +576,9 @@ public ObjectAccessControl apply(Acl acl) {
     Map<String, String> pbMetadata = metadata;
     if (metadata != null && !Data.isNull(metadata)) {
       pbMetadata = Maps.newHashMapWithExpectedSize(metadata.size());
-      for (String key : metadata.keySet()) {
-        pbMetadata.put(key, firstNonNull(metadata.get(key), Data.<String>nullOf(String.class)));
+      for (Map.Entry<String, String> entry : metadata.entrySet()) {
+        pbMetadata.put(entry.getKey(),
+            firstNonNull(entry.getValue(), Data.<String>nullOf(String.class)));
       }
     }
     storageObject.setMetadata(pbMetadata);

gcloud-java-storage/src/main/java/com/google/gcloud/storage/BlobReadChannel.java

@@ -26,8 +26,10 @@
 /**
  * A channel for reading data from a Google Cloud Storage object.
  *
- * Implementations of this class may buffer data internally to reduce remote calls. This interface
- * implements {@link Restorable} to allow saving the reader's state to continue reading afterwards.
+ * <p>Implementations of this class may buffer data internally to reduce remote calls. This
+ * interface implements {@link Restorable} to allow saving the reader's state to continue reading
+ * afterwards.
+ * </p>
  */
 public interface BlobReadChannel extends ReadableByteChannel, Closeable,
     Restorable<BlobReadChannel> {

gcloud-java-storage/src/main/java/com/google/gcloud/storage/BlobWriteChannel.java

@@ -25,9 +25,10 @@
 /**
  * A channel for writing data to a Google Cloud Storage object.
  *
- * Implementations of this class may further buffer data internally to reduce remote calls. Written
- * data will only be visible after calling {@link #close()}. This interface implements
+ * <p>Implementations of this class may further buffer data internally to reduce remote calls.
+ * Written data will only be visible after calling {@link #close()}. This interface implements
  * {@link Restorable} to allow saving the writer's state to continue writing afterwards.
+ * </p>
  */
 public interface BlobWriteChannel extends WritableByteChannel, Closeable,
     Restorable<BlobWriteChannel> {

gcloud-java-storage/src/main/java/com/google/gcloud/storage/BlobWriteChannelImpl.java

@@ -91,7 +91,7 @@ private void flush() {
         runWithRetries(callable(new Runnable() {
           @Override
           public void run() {
-            storageRpc.write(uploadId, buffer, 0, storageObject, position, length, false);
+            storageRpc.write(uploadId, buffer, 0, position, length, false);
           }
         }), options.retryParams(), StorageImpl.EXCEPTION_HANDLER);
       } catch (RetryHelper.RetryHelperException e) {
@@ -139,7 +139,7 @@ public void close() throws IOException {
         runWithRetries(callable(new Runnable() {
           @Override
           public void run() {
-            storageRpc.write(uploadId, buffer, 0, storageObject, position, limit, true);
+            storageRpc.write(uploadId, buffer, 0, position, limit, true);
           }
         }), options.retryParams(), StorageImpl.EXCEPTION_HANDLER);
       } catch (RetryHelper.RetryHelperException e) {

gcloud-java-storage/src/main/java/com/google/gcloud/storage/Bucket.java

@@ -46,8 +46,7 @@
 /**
  * A Google cloud storage bucket.
  *
- * <p>
- * Objects of this class are immutable. Operations that modify the bucket like {@link #update}
+ * <p>Objects of this class are immutable. Operations that modify the bucket like {@link #update}
  * return a new object. To get a {@code Bucket} object with the most recent information use
  * {@link #reload}.
  * </p>
@@ -72,7 +71,7 @@ private static class BlobPageFetcher implements PageImpl.NextPageFetcher<Blob> {
     @Override
     public Page<Blob> nextPage() {
       Page<BlobInfo> nextInfoPage = infoPage.nextPage();
-      return new PageImpl<Blob>(new BlobPageFetcher(options, nextInfoPage),
+      return new PageImpl<>(new BlobPageFetcher(options, nextInfoPage),
           nextInfoPage.nextPageCursor(), new LazyBlobIterable(options, nextInfoPage.values()));
     }
   }

gcloud-java-storage/src/main/java/com/google/gcloud/storage/CopyWriter.java

@@ -55,8 +55,8 @@ public class CopyWriter implements Restorable<CopyWriter> {
   /**
    * Returns the updated information for the written blob. Calling this method when {@code isDone()}
    * is {@code false} will block until all pending chunks are copied.
-   * <p>
-   * This method has the same effect of doing:
+   *
+   * <p>This method has the same effect of doing:
    * <pre>    {@code while (!copyWriter.isDone()) {
    *        copyWriter.copyChunk();
    *    }}

gcloud-java-storage/src/main/java/com/google/gcloud/storage/Option.java

@@ -25,7 +25,7 @@
 import java.util.Objects;
 
 /**
- * Base class for Storage operation option
+ * Base class for Storage operation option.
  */
 class Option implements Serializable {