From 497a0399cfb868d9f6db9fa39093a7d1569cc1c9 Mon Sep 17 00:00:00 2001 From: Sebastian Schmidt Date: Mon, 29 Jul 2019 11:22:43 -0700 Subject: [PATCH 1/2] Add @Deprecated annotation to getCollections --- .../java/com/google/cloud/firestore/DocumentReference.java | 3 +++ .../src/main/java/com/google/cloud/firestore/Firestore.java | 1 + 2 files changed, 4 insertions(+) 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 index 054fe5a1ab30..681c33b0e8ad 100644 --- 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 get() { * @throws FirestoreException if the Iterable could not be initialized. * @return An Iterable that can be used to fetch all subcollections. */ + @Nonnull public Iterable 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 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 index 32d223f99a4d..b4d1aa24bfbd 100644 --- 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 @@ -59,6 +59,7 @@ public interface Firestore extends Service, AutoCloseable { * @throws FirestoreException if the Iterable could not be initialized. * @return An Iterable that can be used to fetch all collections. */ + @Deprecated @Nonnull Iterable getCollections(); From 26f2be639c5f64179abde7cffa348bb43f54659c Mon Sep 17 00:00:00 2001 From: Sebastian Schmidt Date: Mon, 29 Jul 2019 13:00:35 -0700 Subject: [PATCH 2/2] Use @link in JavaDoc --- .../main/java/com/google/cloud/firestore/DocumentReference.java | 2 +- .../src/main/java/com/google/cloud/firestore/Firestore.java | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) 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 index 681c33b0e8ad..3a6e95b8ad33 100644 --- 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 @@ -403,7 +403,7 @@ public void remove() { /** * Fetches the subcollections that are direct children of this document. * - * @deprecated Use `listCollections()`. + * @deprecated Use {@link #listCollections()}. * @throws FirestoreException if the Iterable could not be initialized. * @return An Iterable that can be used to fetch all subcollections. */ 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 index b4d1aa24bfbd..cf1be3eb3826 100644 --- 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 @@ -55,7 +55,7 @@ public interface Firestore extends Service, AutoCloseable { /** * Fetches the root collections that are associated with this Firestore database. * - * @deprecated Use `listCollections()`. + * @deprecated Use {@link #listCollections()}. * @throws FirestoreException if the Iterable could not be initialized. * @return An Iterable that can be used to fetch all collections. */