Add @deprecated annotation to getCollections

schmidt-sebastian · schmidt-sebastian · commit f6a9c43c5362 · 2019-07-29T11:22:43.000-07:00
diff --git a/google-cloud-clients/google-cloud-firestore/src/main/java/com/google/cloud/firestore/DocumentReference.java b/google-cloud-clients/google-cloud-firestore/src/main/java/com/google/cloud/firestore/DocumentReference.java
@@ -360,6 +360,7 @@ public ApiFuture<DocumentSnapshot> get() {
    * @throws FirestoreException if the Iterable could not be initialized.
    * @return An Iterable that can be used to fetch all subcollections.
    */
+  @Nonnull
   public Iterable<CollectionReference> listCollections() {
     ListCollectionIdsRequest.Builder request = ListCollectionIdsRequest.newBuilder();
     request.setParent(path.toString());
@@ -406,6 +407,8 @@ public void remove() {
    * @throws FirestoreException if the Iterable could not be initialized.
    * @return An Iterable that can be used to fetch all subcollections.
    */
+  @Deprecated
+  @Nonnull
   public Iterable<CollectionReference> getCollections() {
     return listCollections();
   }
diff --git a/google-cloud-clients/google-cloud-firestore/src/main/java/com/google/cloud/firestore/Firestore.java b/google-cloud-clients/google-cloud-firestore/src/main/java/com/google/cloud/firestore/Firestore.java
@@ -60,6 +60,7 @@ public interface Firestore extends Service<FirestoreOptions>, AutoCloseable {
    * @return An Iterable that can be used to fetch all collections.
    */
   @Nonnull
+  @Deprecated
   Iterable<CollectionReference> getCollections();
 
   /**
