DocumentChangeInfo
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, i.e. 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 |
|
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 | |
|---|---|
Public constructors
DocumentChangeInfo
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
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 returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
The equals method for class Object implements
the most discriminating possible equivalence relation on objects;
that is, for any non-null reference values x and
y, this method returns true if and only
if x and y refer to the same object
(x == y has the value true).
Note that it is generally necessary to override the hashCode
method whenever this method is overridden, so as to maintain the
general contract for the hashCode method, which states
that equal objects must have equal hash codes.
| Parameters | |
|---|---|
o |
Object: This value may be null. |
| Returns | |
|---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
getChangedDocumentIds
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
public String getDatabaseName ()
Returns the database in which the documents that was changed reside.
| Returns | |
|---|---|
String |
This value cannot be null. |
getNamespace
public String getNamespace ()
Returns the namespace of the documents that changed.
| Returns | |
|---|---|
String |
This value cannot be null. |
getPackageName
public String getPackageName ()
Returns the package name of the app which owns the documents that changed.
| Returns | |
|---|---|
String |
This value cannot be null. |
getSchemaName
public String getSchemaName ()
Returns the name of the schema type that contains the changed documents.
| Returns | |
|---|---|
String |
This value cannot be null. |
hashCode
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
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons 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(Object)method, then calling thehashCodemethod 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(java.lang.Object)method, then calling thehashCodemethod 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.
As much as is reasonably practical, the hashCode method defined by
class Object does return distinct integers for distinct
objects. (This is typically implemented by converting the internal
address of the object into an integer, but this implementation
technique is not required by the
Java™ programming language.)
| Returns | |
|---|---|
int |
a hash code value for this object. |
toString
public String toString ()
Returns a string representation of the object. In general, the
toString method returns a string that
"textually represents" this object. The result should
be a concise but informative representation that is easy for a
person to read.
It is recommended that all subclasses override this method.
The toString method for class Object
returns a string consisting of the name of the class of which the
object is an instance, the at-sign character `@', and
the unsigned hexadecimal representation of the hash code of the
object. In other words, this method returns a string equal to the
value of:
getClass().getName() + '@' + Integer.toHexString(hashCode())
| Returns | |
|---|---|
String |
This value cannot be null. |