com.google.cloud.firestore

Class QuerySnapshot

java.lang.Object

com.google.cloud.firestore.QuerySnapshot

All Implemented Interfaces:

Iterable<DocumentSnapshot>

public final class QuerySnapshot
extends Object
implements Iterable<DocumentSnapshot>

A QuerySnapshot contains the results of a query. It can contain zero or more DocumentSnapshot objects.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
List<DocumentSnapshot>	getDocuments() Returns the documents in this QuerySnapshot as a List in order of the query.
Query	getQuery() Returns the query for the snapshot.
org.threeten.bp.Instant	getReadTime() Returns the time at which this snapshot was read.
int	hashCode()
boolean	isEmpty() Returns true if there are no documents in the QuerySnapshot.
Iterator<DocumentSnapshot>	iterator()
int	size() Returns the number of documents in the QuerySnapshot.
<T> List<T>	toObjects(Class<T> clazz) Returns the contents of the documents in the QuerySnapshot, converted to the provided class, as a list.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

getQuery

@Nonnull
public Query getQuery()

Returns the query for the snapshot.

Returns:

The backing query that produced this snapshot.

getReadTime

@Nonnull
public org.threeten.bp.Instant getReadTime()

Returns the time at which this snapshot was read.

Returns:

The read time of this snapshot.

getDocuments

@Nonnull
public List<DocumentSnapshot> getDocuments()

Returns the documents in this QuerySnapshot as a List in order of the query.

Returns:

The list of documents.

isEmpty

public boolean isEmpty()

Returns true if there are no documents in the QuerySnapshot.

size

public int size()

Returns the number of documents in the QuerySnapshot.

iterator

@Nonnull
public Iterator<DocumentSnapshot> iterator()

Specified by:

iterator in interface Iterable<DocumentSnapshot>

toObjects

@Nonnull
public <T> List<T> toObjects(@Nonnull
                                      Class<T> clazz)

Returns the contents of the documents in the QuerySnapshot, converted to the provided class, as a list.

Parameters:

clazz - The POJO type used to convert the documents in the list.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object