Skip to content

Firestore: Add @Deprecated annotation to getCollections #5916

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
schmidt-sebastian merged 2 commits into from
Jul 30, 2019
Merged

Firestore: Add @Deprecated annotation to getCollections #5916

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
497a039
Add @Deprecated annotation to getCollections
schmidt-sebastian Jul 29, 2019
26f2be6
Use @link in JavaDoc
schmidt-sebastian Jul 29, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion ...ts/google-cloud-firestore/src/main/java/com/google/cloud/firestore/DocumentReference.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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());
Expand Down Expand Up @@ -402,10 +403,12 @@ 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.
*/
@Deprecated
@Nonnull
public Iterable<CollectionReference> getCollections() {
return listCollections();
}
Expand Down
3 changes: 2 additions & 1 deletion ...ud-clients/google-cloud-firestore/src/main/java/com/google/cloud/firestore/Firestore.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,10 +55,11 @@ public interface Firestore extends Service<FirestoreOptions>, 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.
*/
@Deprecated
@Nonnull
Iterable<CollectionReference> getCollections();

Expand Down