AppSearchSchema.StringPropertyConfig.Builder


public static final class AppSearchSchema.StringPropertyConfig.Builder
extends Object

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


Builder for StringPropertyConfig.

Summary

Public constructors

Builder(String propertyName)

Creates a new StringPropertyConfig.Builder.

Public methods

AppSearchSchema.StringPropertyConfig build()

Constructs a new StringPropertyConfig from the contents of this builder.

AppSearchSchema.StringPropertyConfig.Builder setCardinality(int cardinality)

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

AppSearchSchema.StringPropertyConfig.Builder setIndexingType(int indexingType)

Configures how a property should be indexed so that it can be retrieved by queries.

AppSearchSchema.StringPropertyConfig.Builder setJoinableValueType(int joinableValueType)

Configures how this property should be used as a joining matcher.

AppSearchSchema.StringPropertyConfig.Builder setTokenizerType(int tokenizerType)

Configures how this property should be tokenized (split into words).

Inherited methods

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 constructors

Builder

Added in API level 31
public Builder (String propertyName)

Creates a new StringPropertyConfig.Builder.

Parameters
propertyName String: This value cannot be null.

Public methods

build

Added in API level 31
public AppSearchSchema.StringPropertyConfig build ()

Constructs a new StringPropertyConfig from the contents of this builder.

Returns
AppSearchSchema.StringPropertyConfig This value cannot be null.

setCardinality

Added in API level 31
public AppSearchSchema.StringPropertyConfig.Builder setCardinality (int cardinality)

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

If this method is not called, the default cardinality is AppSearchSchema.PropertyConfig.CARDINALITY_OPTIONAL.

Returns
AppSearchSchema.StringPropertyConfig.Builder This value cannot be null.

setIndexingType

Added in API level 31
public AppSearchSchema.StringPropertyConfig.Builder setIndexingType (int indexingType)

Configures how a property should be indexed so that it can be retrieved by queries.

If this method is not called, the default indexing type is AppSearchSchema.StringPropertyConfig.INDEXING_TYPE_NONE, so that it cannot be matched by queries.

Returns
AppSearchSchema.StringPropertyConfig.Builder This value cannot be null.

setJoinableValueType

Added in API level 34
Also in T Extensions 7
public AppSearchSchema.StringPropertyConfig.Builder setJoinableValueType (int joinableValueType)

Configures how this property should be used as a joining matcher.

If this method is not called, the default joinable value type is AppSearchSchema.StringPropertyConfig.JOINABLE_VALUE_TYPE_NONE, so that it is not joinable.

At most, 64 properties can be set as joinable per schema.

Returns
AppSearchSchema.StringPropertyConfig.Builder This value cannot be null.

setTokenizerType

Added in API level 31
public AppSearchSchema.StringPropertyConfig.Builder setTokenizerType (int tokenizerType)

Configures how this property should be tokenized (split into words).

If this method is not called, the default indexing type is AppSearchSchema.StringPropertyConfig.TOKENIZER_TYPE_NONE, so that it is not tokenized.

This method must be called with a value other than AppSearchSchema.StringPropertyConfig.TOKENIZER_TYPE_NONE if the property is indexed (that is, if setIndexingType(int) has been called with a value other than AppSearchSchema.StringPropertyConfig.INDEXING_TYPE_NONE).

Returns
AppSearchSchema.StringPropertyConfig.Builder This value cannot be null.