Class QueryDocumentSnapshot (3.4.2)

Stay organized with collections Save and categorize content based on your preferences.
public class QueryDocumentSnapshot extends DocumentSnapshot

A QueryDocumentSnapshot contains data read from a document in a Firestore database as part of a query. The document is guaranteed to exist and its data can be extracted using the #getData() or #get(String) methods.

QueryDocumentSnapshot offers the same API surface as DocumentSnapshot. Since query results contain only existing documents, the #exists() method will always return true and getData() will never be null.

Subclassing Note: Firestore classes are not meant to be subclassed except for use in test mocks. Subclassing is not supported in production code and new SDK releases may break code that does so.

Inheritance

java.lang.Object > DocumentSnapshot > QueryDocumentSnapshot

Methods

<T>toObject(Class<T> valueType)

public T <T>toObject(Class<T> valueType)

Returns the contents of the document converted to a POJO.

Parameter
NameDescription
valueTypeClass<T>

The Java class to create

Returns
TypeDescription
T

The contents of the document in an object of type T

Overrides

getData()

public Map<String,Object> getData()

Returns the fields of the document as a Map. Field values will be converted to their native Java representation.

Returns
TypeDescription
Map<String,Object>

The fields of the document as a Map.

Overrides