AppSearchSchema.StringPropertyConfig.Builder

public static final class AppSearchSchema.StringPropertyConfig.Builder
extends Object

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


Builder for AppSearchSchema.StringPropertyConfig.

Summary

Public constructors

Builder(String propertyName)

Creates a new AppSearchSchema.StringPropertyConfig.Builder.

Public methods

AppSearchSchema.StringPropertyConfig build()

Constructs a new AppSearchSchema.StringPropertyConfig from the contents of this builder.

AppSearchSchema.StringPropertyConfig.Builder setCardinality(int cardinality)

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 setTokenizerType(int tokenizerType)

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

Inherited methods

Public constructors

Builder

public Builder (String propertyName)

Creates a new AppSearchSchema.StringPropertyConfig.Builder.

Parameters
propertyName String

Public methods

build

public AppSearchSchema.StringPropertyConfig build ()

Constructs a new AppSearchSchema.StringPropertyConfig from the contents of this builder.

Returns
AppSearchSchema.StringPropertyConfig

setCardinality

public AppSearchSchema.StringPropertyConfig.Builder setCardinality (int cardinality)

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.

Parameters
cardinality int

Returns
AppSearchSchema.StringPropertyConfig.Builder

setIndexingType

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.

Parameters
indexingType int

Returns
AppSearchSchema.StringPropertyConfig.Builder

setTokenizerType

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 (i.e. if setIndexingType(int) has been called with a value other than AppSearchSchema.StringPropertyConfig.INDEXING_TYPE_NONE).

Parameters
tokenizerType int

Returns
AppSearchSchema.StringPropertyConfig.Builder