AppSearchSchema


public final class AppSearchSchema
extends Object implements Parcelable

java.lang.Object
   ↳ android.app.appsearch.AppSearchSchema


The AppSearch Schema for a particular type of document.

For example, an e-mail message or a music recording could be a schema type.

The schema consists of type information, properties, and config (like tokenization type).

Summary

Nested classes

class AppSearchSchema.BooleanPropertyConfig

Configuration for a property containing a boolean. 

class AppSearchSchema.Builder

Builder for objects

class AppSearchSchema.BytesPropertyConfig

Configuration for a property containing a byte array. 

class AppSearchSchema.DocumentPropertyConfig

Configuration for a property containing another Document. 

class AppSearchSchema.DoublePropertyConfig

Configuration for a property containing a double-precision decimal number. 

class AppSearchSchema.LongPropertyConfig

Configuration for a property containing a 64-bit integer. 

class AppSearchSchema.PropertyConfig

Common configuration for a single property (field) in a Document. 

class AppSearchSchema.StringPropertyConfig

Configuration for a property of type String in a Document. 

Inherited constants

Fields

public static final Creator<AppSearchSchema> CREATOR

Public methods

boolean equals(Object other)

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

List<String> getParentTypes()

Returns the list of parent types of this schema for polymorphism.

List<AppSearchSchema.PropertyConfig> getProperties()

Returns the list of PropertyConfigs that are part of this schema.

String getSchemaType()

Returns the name of this schema type, such as Email.

int hashCode()

Returns a hash code value for the object.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Fields

CREATOR

Added in API level 35
public static final Creator<AppSearchSchema> CREATOR

Public methods

equals

Added in API level 31
public boolean equals (Object other)

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
other Object: This value may be null.

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

getParentTypes

Added in API level 35
public List<String> getParentTypes ()

Returns the list of parent types of this schema for polymorphism.

Returns
List<String> This value cannot be null.

getProperties

Added in API level 31
public List<AppSearchSchema.PropertyConfig> getProperties ()

Returns the list of PropertyConfigs that are part of this schema.

This method creates a new list when called.

Returns
List<AppSearchSchema.PropertyConfig> This value cannot be null.

getSchemaType

Added in API level 31
public String getSchemaType ()

Returns the name of this schema type, such as Email.

Returns
String This value cannot be null.

hashCode

Added in API level 31
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 31
public String toString ()

Returns a string representation of the object.

Returns
String This value cannot be null.

writeToParcel

Added in API level 35
public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest Parcel: This value cannot be null.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES