DocumentChange

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: Cloud 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` (assuming that all prior `DocumentChange` objects and the current `DocumentChange` object have been applied).
int	getOldIndex() The index of the changed document in the result set immediately prior to this `DocumentChange` (assuming that all prior `DocumentChange` objects have been applied).
DocumentChange.Type	getType()
int	hashCode()

Inherited Method Summary

From class java.lang.Object

Object	clone()
boolean	equals(Object arg0)
void	finalize()
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

Public Methods

public boolean equals (Object object)

Parameters

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 ADDED or MODIFIED) or the removed data (for ERROR(/DocumentChange.Type.REMOVED)).

public int getNewIndex ()

The index of the changed document in the result set immediately after this DocumentChange (assuming 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 (assuming that all prior DocumentChange objects have been applied). Returns -1 for 'added' events.