SchemaChangeInfo


public final class SchemaChangeInfo
extends Object

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


Contains information about a schema change detected by an ObserverCallback.

This object will be sent when a schema type having a name matching an observer's schema filters (as determined by ObserverSpec#getFilterSchemas) has been added, updated, or removed.

Note that schema changes may cause documents to be migrated or removed. When this happens, individual document updates will NOT be dispatched via DocumentChangeInfo. The only notification will be of the schema type change via SchemaChangeInfo. Depending on your use case, you may need to re-query the whole schema type when this happens.

Summary

Public constructors

SchemaChangeInfo(String packageName, String databaseName, Set<String> changedSchemaNames)

Constructs a new SchemaChangeInfo.

Public methods

boolean equals(Object o)

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

Set<String> getChangedSchemaNames()

Returns the names of schema types affected by this change notification.

String getDatabaseName()

Returns the database in which the schema that was changed resides.

String getPackageName()

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

int hashCode()

Returns a hash code value for the object.

String toString()

Returns a string representation of the object.

Inherited methods

Public constructors

SchemaChangeInfo

Added in API level 33
public SchemaChangeInfo (String packageName, 
                String databaseName, 
                Set<String> changedSchemaNames)

Constructs a new SchemaChangeInfo.

Parameters
packageName String: The package name of the app which owns the schema that changed. This value cannot be null.

databaseName String: The database in which the schema that changed resides. This value cannot be null.

changedSchemaNames Set: Names of schemas that have 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.

getChangedSchemaNames

Added in API level 33
public Set<String> getChangedSchemaNames ()

Returns the names of schema types affected by this change notification.

This will never be empty.

Returns
Set<String> This value cannot be null.

getDatabaseName

Added in API level 33
public String getDatabaseName ()

Returns the database in which the schema that was changed resides.

Returns
String This value cannot be null.

getPackageName

Added in API level 33
public String getPackageName ()

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

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.