Class DocumentSnapshot (3.41.0) (original) (raw)

public class DocumentSnapshot

A DocumentSnapshot contains data read from a document in a Firestore database. The data can be extracted with the #getData() or #get(String) methods.

If the DocumentSnapshot points to a non-existing document, getData() and its corresponding methods will return null. You can always explicitly check for a document's existence by calling#exists().

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

Object > DocumentSnapshot

Inherited Members

Methods

get(FieldPath fieldPath, Class valueType)

public T <T>get(FieldPath fieldPath, Class<T> valueType)

Returns the value at the field, converted to a POJO, or null if the field or document doesn't exist.

get(String field, Class valueType)

public T <T>get(String field, Class<T> valueType)

Returns the value at the field, converted to a POJO, or null if the field or document doesn't exist.

toObject(Class valueType)

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

Returns the contents of the document converted to a POJO or null if the document doesn't exist.

contains(FieldPath fieldPath)

public boolean contains(FieldPath fieldPath)

Returns whether or not the field exists in the document. Returns false if the document does not exist.

contains(String field)

public boolean contains(String field)

Returns whether or not the field exists in the document. Returns false if the document does not exist.

equals(Object obj)

public boolean equals(Object obj)

Returns true if the document's data and path in this DocumentSnapshot equals the provided snapshot.

Overrides

exists()

Returns whether or not the field exists in the document. Returns false if the document does not exist.

get(FieldPath fieldPath)

public Object get(FieldPath fieldPath)

Returns the value at the field or null if the field doesn't exist.

get(String field)

public Object get(String field)

Returns the value at the field or null if the field doesn't exist.

getBlob(String field)

public Blob getBlob(String field)

Returns the value of the field as a Blob.

getBoolean(String field)

public Boolean getBoolean(String field)

Returns the value of the field as a boolean.

getCreateTime()

public Timestamp getCreateTime()

Returns the time at which this document was created. Returns null for non-existing documents.

getData()

public Map<String,Object> getData()

Returns the fields of the document as a Map or null if the document doesn't exist. Field values will be converted to their native Java representation.

getDate(String field)

public Date getDate(String field)

Returns the value of the field as a Date.

getDouble(String field)

public Double getDouble(String field)

Returns the value of the field as a double.

getGeoPoint(String field)

public GeoPoint getGeoPoint(String field)

Returns the value of the field as a GeoPoint.

getId()

Returns the ID of the document contained in this snapshot.

getLong(String field)

public Long getLong(String field)

Returns the value of the field as a long.

getReadTime()

public Timestamp getReadTime()

Returns the time at which this snapshot was read.

getReference()

public DocumentReference getReference()

Gets the reference to the document.

getString(String field)

public String getString(String field)

Returns the value of the field as a String.

getTimestamp(String field)

public Timestamp getTimestamp(String field)

Returns the value of the field as a Timestamp.

getUpdateTime()

public Timestamp getUpdateTime()

Returns the time at which this document was last updated. Returns null for non-existing documents.

getVectorValue(String field)

public VectorValue getVectorValue(String field)

Returns the value of the field as a VectorValue.

hashCode()

Overrides

toString()

Overrides