Added in API level 33
Also in T Extensions 3

Summary: Ctors | Methods | Inherited Methods

DocumentChangeInfo

---

Kotlin |Java

public final class DocumentChangeInfo
extends Object

java.lang.Object
↳	android.app.appsearch.observer.DocumentChangeInfo

---

Contains information about an individual change detected by an ObserverCallback.

This class reports information about document changes, that is, when documents were added, updated or removed.

Changes are grouped by package, database, schema type and namespace. Each unique combination of these items will generate a unique DocumentChangeInfo.

Notifications are only sent for documents whose schema type matches an observer's schema filters (as determined by ObserverSpec.getFilterSchemas).

Note that document changes that happen during schema migration from calling AppSearchSession.setSchema(SetSchemaRequest, Executor, Executor, Consumer) are not reported via this class. Such changes are reported through SchemaChangeInfo.

Summary

Public constructors
DocumentChangeInfo(String packageName, String database, String namespace, String schemaName, Set<String> changedDocumentIds) Constructs a new DocumentChangeInfo.

Public methods
boolean	equals(Object o) Indicates whether some other object is "equal to" this one.
Set<String>	getChangedDocumentIds() Returns the set of document IDs that have been changed as part of this notification.
String	getDatabaseName() Returns the database in which the documents that was changed reside.
String	getNamespace() Returns the namespace of the documents that changed.
String	getPackageName() Returns the package name of the app which owns the documents that changed.
String	getSchemaName() Returns the name of the schema type that contains the changed documents.
int	hashCode() Returns a hash code value for the object.
String	toString() Returns a string representation of the object.

Inherited methods

From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

DocumentChangeInfo

Added in API level 33
Also in T Extensions 3

public DocumentChangeInfo (String packageName, 
                String database, 
                String namespace, 
                String schemaName, 
                Set<String> changedDocumentIds)

Constructs a new DocumentChangeInfo.

Parameters
packageName	String: The package name of the app which owns the documents that changed. This value cannot be null.
database	String: The database in which the documents that changed reside. This value cannot be null.
namespace	String: The namespace in which the documents that changed reside. This value cannot be null.
schemaName	String: The name of the schema type that contains the changed documents. This value cannot be null.
changedDocumentIds	Set: The set of document IDs that have been changed as part of this notification. This value cannot be null.

Public methods

equals

Added in API level 33

public boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o	Object: This value may be null.

Returns
boolean	true if this object is the same as the obj argument; false otherwise.

getChangedDocumentIds

Added in API level 33
Also in T Extensions 3

public Set<String> getChangedDocumentIds ()

Returns the set of document IDs that have been changed as part of this notification.

This will never be empty.

Returns
Set<String>	This value cannot be null.

getDatabaseName

Added in API level 33
Also in T Extensions 3

public String getDatabaseName ()

Returns the database in which the documents that was changed reside.

Returns
String	This value cannot be null.

getNamespace

Added in API level 33
Also in T Extensions 3

public String getNamespace ()

Returns the namespace of the documents that changed.

Returns
String	This value cannot be null.

getPackageName

Added in API level 33
Also in T Extensions 3

public String getPackageName ()

Returns the package name of the app which owns the documents that changed.

Returns
String	This value cannot be null.

getSchemaName

Added in API level 33
Also in T Extensions 3

public String getSchemaName ()

Returns the name of the schema type that contains the changed documents.

Returns
String	This value cannot be null.

hashCode

Added in API level 33

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns
int	a hash code value for this object.

toString

Added in API level 33

public String toString ()

Returns a string representation of the object.

Returns
String	This value cannot be null.