DocumentChange

public class 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.

Summary

Nested types
public enum DocumentChange.Type An enumeration of snapshot diff types.

Public fields
final QueryDocumentSnapshot	document
final int	newIndex The index in the new snapshot, after processing all previous changes.
final int	oldIndex The index in the old snapshot, after processing all previous changes.
final DocumentChange.Type	type

Public methods
boolean	equals(@Nullable Object object)
@NonNull 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).
@NonNull DocumentChange.Type	getType()
int	hashCode()

Public fields

document

public final QueryDocumentSnapshot document

newIndex

public final int newIndex

The index in the new snapshot, after processing all previous changes.

oldIndex

public final int oldIndex

The index in the old snapshot, after processing all previous changes.

type

public final DocumentChange.Type type

Public methods

equals

public boolean equals(@Nullable Object object)

getDocument

public @NonNull 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
@NonNull QueryDocumentSnapshot	A snapshot of the new data (for ADDED or MODIFIED) or the removed data (for REMOVED).

getNewIndex

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.

getOldIndex

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.

getType

public @NonNull DocumentChange.Type getType()

hashCode

public int hashCode()