Stay organized with collections Save and categorize content based on your preferences.

public static final class AppSearchSchema.DocumentPropertyConfig
extends AppSearchSchema.PropertyConfig



Configuration for a property containing another Document.

Summary

Nested classes

class AppSearchSchema.DocumentPropertyConfig.Builder

Builder for DocumentPropertyConfig

Inherited constants

From class android.app.appsearch.AppSearchSchema.PropertyConfig

int CARDINALITY_OPTIONAL

Zero or one value [0,1].

int CARDINALITY_REPEATED

Any number of items (including zero) [0...*].

int CARDINALITY_REQUIRED

Exactly one value [1].

Public methods

String getSchemaType()

Returns the logical schema-type of the contents of this document property.

boolean shouldIndexNestedProperties()

Returns whether fields in the nested document should be indexed according to that document's schema.

Inherited methods

From class android.app.appsearch.AppSearchSchema.PropertyConfig

boolean equals(Object other)

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

int getCardinality()

Returns the cardinality of the property (whether it is optional, required or repeated).

String getName()

Returns the name of this property.

int hashCode()

Returns a hash code value for the object.

String toString()

Returns a string representation of the object.

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 methods

getSchemaType

Added in API level 31

public String getSchemaType ()

Returns the logical schema-type of the contents of this document property.

Returns
String This value cannot be null.

shouldIndexNestedProperties

Added in API level 31

public boolean shouldIndexNestedProperties ()

Returns whether fields in the nested document should be indexed according to that document's schema.

If false, the nested document's properties are not indexed regardless of its own schema.

Returns
boolean

Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.

Last updated 2023-02-08 UTC.