Add javadoc to CloudStorageConfiguration

jean-philippe-martin · jean-philippe-martin · commit 0c1c20832146 · 2016-11-28T09:21:20.000-08:00
diff --git a/google-cloud-contrib/google-cloud-nio/src/main/java/com/google/cloud/storage/contrib/nio/CloudStorageConfiguration.java b/google-cloud-contrib/google-cloud-nio/src/main/java/com/google/cloud/storage/contrib/nio/CloudStorageConfiguration.java
@@ -31,31 +31,31 @@ public abstract class CloudStorageConfiguration {
   public static final CloudStorageConfiguration DEFAULT = builder().build();
 
   /**
-   * Returns path of current working directory. This defaults to the root directory.
+   * @return path of current working directory. This defaults to the root directory.
    */
   public abstract String workingDirectory();
 
   /**
-   * Returns {@code true} if we <i>shouldn't</i> throw an exception when encountering object names
+   * @return {@code true} if we <i>shouldn't</i> throw an exception when encountering object names
    * containing superfluous slashes, e.g. {@code a//b}.
    */
   public abstract boolean permitEmptyPathComponents();
 
   /**
-   * Returns {@code true} if '/' prefix on absolute object names should be removed before I/O.
+   * @return {@code true} if '/' prefix on absolute object names should be removed before I/O.
    *
    * <p>If you disable this feature, please take into consideration that all paths created from a
    * URI will have the leading slash.
    */
   public abstract boolean stripPrefixSlash();
 
   /**
-   * Returns {@code true} if paths with a trailing slash should be treated as fake directories.
+   * @return {@code true} if paths with a trailing slash should be treated as fake directories.
    */
   public abstract boolean usePseudoDirectories();
 
   /**
-   * Returns block size (in bytes) used when talking to the Google Cloud Storage HTTP server.
+   * @return block size (in bytes) used when talking to the Google Cloud Storage HTTP server.
    */
   public abstract int blockSize();
 
@@ -67,6 +67,8 @@ public abstract class CloudStorageConfiguration {
    * <li>The prefix slash on absolute paths will be removed when converting to an object name.
    * <li>Pseudo-directories are enabled, so any path with a trailing slash is a fake directory.
    * </ul>
+   *
+   * @return builder
    */
   public static Builder builder() {
     return new Builder();
@@ -89,6 +91,7 @@ public static final class Builder {
      * {@link CloudStorageFileSystem} object.
      *
      * @throws IllegalArgumentException if {@code path} is not absolute.
+     * @return builder
      */
     public Builder workingDirectory(String path) {
       checkArgument(UnixPath.getPath(false, path).isAbsolute(), "not absolute: %s", path);
@@ -99,6 +102,8 @@ public Builder workingDirectory(String path) {
     /**
      * Configures whether or not we should throw an exception when encountering object names
      * containing superfluous slashes, e.g. {@code a//b}.
+     *
+     * @return builder
      */
     public Builder permitEmptyPathComponents(boolean value) {
       permitEmptyPathComponents = value;
@@ -110,6 +115,9 @@ public Builder permitEmptyPathComponents(boolean value) {
      *
      * <p>If you disable this feature, please take into consideration that all paths created from a
      * URI will have the leading slash.
+     *
+     * @parm value if true, remove the '/' prefix on absolute object names
+     * @return builder
      */
     public Builder stripPrefixSlash(boolean value) {
       stripPrefixSlash = value;
@@ -118,6 +126,9 @@ public Builder stripPrefixSlash(boolean value) {
 
     /**
      * Configures if paths with a trailing slash should be treated as fake directories.
+     *
+     * @parm value whether paths with a trailing slash should be treated as fake directories.
+     * @return builder
      */
     public Builder usePseudoDirectories(boolean value) {
       usePseudoDirectories = value;
@@ -128,6 +139,9 @@ public Builder usePseudoDirectories(boolean value) {
      * Sets the block size in bytes that should be used for each HTTP request to the API.
      *
      * <p>The default is {@value CloudStorageFileSystem#BLOCK_SIZE_DEFAULT}.
+     *
+     * @parm value block size in bytes that should be used for each HTTP request to the API.
+     * @return builder
      */
     public Builder blockSize(int value) {
       blockSize = value;
@@ -136,6 +150,8 @@ public Builder blockSize(int value) {
 
     /**
      * Creates new instance without destroying builder.
+     *
+     * @return CloudStorageConfiguration with the parameters you asked for.
      */
     public CloudStorageConfiguration build() {
       return new AutoValue_CloudStorageConfiguration(
