# Print output for @column tags ?> AppSearchSchema - Android SDK | Android Developers

Most visited

Recently visited

AppSearchSchema

public final class AppSearchSchema
extends Object

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).

See also:

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. 

Public methods

boolean equals(Object other)

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

List<AppSearchSchema.PropertyConfig> getProperties()

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

String getSchemaType()

Returns the name of this schema type, e.g. Email.

int hashCode()

Returns a hash code value for the object.

String toString()

Returns a string representation of the object.

Inherited methods

Public methods

equals

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.

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

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

getProperties

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

public String getSchemaType ()

Returns the name of this schema type, e.g. Email.

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 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(Object) 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(java.lang.Object) 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.

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.