DocumentChange

public class DocumentChange extends Object

A DocumentChange represents a change to the documents matching a query. It contains the document affected and a the type of change that occurred (added, modified, or removed).

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.

Nested Class Summary

enum DocumentChange.Type An enumeration of snapshot diff types. 

Public Method Summary

boolean
equals(Object object)
QueryDocumentSnapshot
getDocument()
Returns the newly added or modified document if this DocumentChange is for an updated document.
int
getNewIndex()
The index of the changed document in the result set immediately after this DocumentChange (i.e.
int
getOldIndex()
The index of the changed document in the result set immediately prior to this DocumentChange (i.e.
DocumentChange.Type
int

Inherited Method Summary

Public Methods

public boolean equals (Object object)

public QueryDocumentSnapshot getDocument ()

Returns the newly added or modified document if this DocumentChange is for an updated document. Returns the deleted document if this document change represents a removal.

Returns
  • A snapshot of the new data (for Type.ADDED or Type.MODIFIED) or the removed data (for Type.REMOVED).

public int getNewIndex ()

The index of the changed document in the result set immediately after this DocumentChange (i.e. supposing that all prior DocumentChange objects and the current DocumentChange object have been applied). Returns -1 for 'removed' events.

public int getOldIndex ()

The index of the changed document in the result set immediately prior to this DocumentChange (i.e. supposing that all prior DocumentChange objects have been applied). Returns -1 for 'added' events.

public DocumentChange.Type getType ()

public int hashCode ()

Send feedback about...

Need help? Visit our support page.