Document limitations of FakeStorageRpc (googleapis#1069)

mziccard · Jun 29, 2016 · e9f3d98 · e9f3d98
1 parent 3299fef
commit e9f3d98
Showing 1 changed file with 17 additions and 2 deletions.
diff --git a/gcloud-java-storage/src/main/java/com/google/cloud/storage/testing/FakeStorageRpc.java b/gcloud-java-storage/src/main/java/com/google/cloud/storage/testing/FakeStorageRpc.java
@@ -37,9 +37,24 @@
 
 /**
  * A bare-bones in-memory implementation of Storage, meant for testing.
- * See LocalGcsHelper.
  *
- * This class is NOT thread-safe.
+ * <p>This class is <i>not</i> thread-safe. It's also (currently) limited in the following ways:
+ * <ul>
+ * <li>Partially Supported
+ *   <ul>
+ *   <li>create
+ *   <li>get
+ *   <li>delete
+ *   <li>directory listing
+ *   </ul>
+ * <li>Unsupported
+ *   <ul>
+ *   <li>generations
+ *   <li>file attributes
+ *   <li>patch
+ *   <li>continueRewrite
+ *   </ul>
+ * </ul>
  */
 @NotThreadSafe
 public class FakeStorageRpc implements StorageRpc {