Add javadoc to Bucket

mziccard · mziccard · commit e2a4500e57e7 · 2015-11-11T15:37:47.000+01:00
diff --git a/gcloud-java-storage/src/main/java/com/google/gcloud/storage/Bucket.java b/gcloud-java-storage/src/main/java/com/google/gcloud/storage/Bucket.java
@@ -122,6 +122,9 @@ public boolean equals(Object obj) {
     }
   }
 
+  /**
+   * Class for specifying bucket source options when {@code Bucket} methods are used.
+   */
   public static class BucketSourceOption extends Option {
 
     private static final long serialVersionUID = 6928872234155522371L;
@@ -152,10 +155,18 @@ private Storage.BucketGetOption toGetOption(BucketInfo bucketInfo) {
       }
     }
 
+    /**
+     * Returns an option for bucket's metageneration match. If this option is used the request will
+     * fail if metageneration does not match.
+     */
     public static BucketSourceOption metagenerationMatch() {
       return new BucketSourceOption(StorageRpc.Option.IF_METAGENERATION_MATCH);
     }
 
+    /**
+     * Returns an option for bucket's metageneration mismatch. If this option is used the request
+     * will fail if metageneration matches.
+     */
     public static BucketSourceOption metagenerationNotMatch() {
       return new BucketSourceOption(StorageRpc.Option.IF_METAGENERATION_NOT_MATCH);
     }

Original file line number	Diff line number	Diff line change
`@@ -122,6 +122,9 @@ public boolean equals(Object obj) {`
`122`	`122`	`}`
`123`	`123`	`}`
`124`	`124`
	`125`	`+ /**`
	`126`	`+ * Class for specifying bucket source options when {@code Bucket} methods are used.`
	`127`	`+ */`
`125`	`128`	`public static class BucketSourceOption extends Option {`
`126`	`129`
`127`	`130`	`private static final long serialVersionUID = 6928872234155522371L;`
`@@ -152,10 +155,18 @@ private Storage.BucketGetOption toGetOption(BucketInfo bucketInfo) {`
`152`	`155`	`}`
`153`	`156`	`}`
`154`	`157`
	`158`	`+ /**`
	`159`	`+ * Returns an option for bucket's metageneration match. If this option is used the request will`
	`160`	`+ * fail if metageneration does not match.`
	`161`	`+ */`
`155`	`162`	`public static BucketSourceOption metagenerationMatch() {`
`156`	`163`	`return new BucketSourceOption(StorageRpc.Option.IF_METAGENERATION_MATCH);`
`157`	`164`	`}`
`158`	`165`
	`166`	`+ /**`
	`167`	`+ * Returns an option for bucket's metageneration mismatch. If this option is used the request`
	`168`	`+ * will fail if metageneration matches.`
	`169`	`+ */`
`159`	`170`	`public static BucketSourceOption metagenerationNotMatch() {`
`160`	`171`	`return new BucketSourceOption(StorageRpc.Option.IF_METAGENERATION_NOT_MATCH);`
`161`	`172`	`}`