Join us for ⁠#Android11: The Beta Launch Show on June 3!

TextClassifier.EntityConfig.Builder

public static final class TextClassifier.EntityConfig.Builder
extends Object

java.lang.Object
   ↳ android.view.textclassifier.TextClassifier.EntityConfig.Builder


Builder class to construct the EntityConfig object.

Summary

Public constructors

TextClassifier.EntityConfig.Builder()

Public methods

TextClassifier.EntityConfig build()

Combines all of the options that have been set and returns a new EntityConfig object.

TextClassifier.EntityConfig.Builder includeTypesFromTextClassifier(boolean includeTypesFromTextClassifier)

Specifies whether or not to include the types suggested by the text classifier.

TextClassifier.EntityConfig.Builder setExcludedTypes(Collection<String> excludedTypes)

Sets a collection of types that are explicitly excluded.

TextClassifier.EntityConfig.Builder setHints(Collection<String> hints)

Sets the hints for the TextClassifier to determine what types of entities to find.

TextClassifier.EntityConfig.Builder setIncludedTypes(Collection<String> includedTypes)

Sets a collection of types that are explicitly included.

Inherited methods

Public constructors

TextClassifier.EntityConfig.Builder

public TextClassifier.EntityConfig.Builder ()

Public methods

build

Added in API level 29
public TextClassifier.EntityConfig build ()

Combines all of the options that have been set and returns a new EntityConfig object.

Returns
TextClassifier.EntityConfig This value cannot be null.

includeTypesFromTextClassifier

Added in API level 29
public TextClassifier.EntityConfig.Builder includeTypesFromTextClassifier (boolean includeTypesFromTextClassifier)

Specifies whether or not to include the types suggested by the text classifier. By default, it is included.

Parameters
includeTypesFromTextClassifier boolean

Returns
TextClassifier.EntityConfig.Builder This value cannot be null.

setExcludedTypes

Added in API level 29
public TextClassifier.EntityConfig.Builder setExcludedTypes (Collection<String> excludedTypes)

Sets a collection of types that are explicitly excluded.

Parameters
excludedTypes Collection: This value may be null.

Returns
TextClassifier.EntityConfig.Builder This value cannot be null.

setHints

Added in API level 29
public TextClassifier.EntityConfig.Builder setHints (Collection<String> hints)

Sets the hints for the TextClassifier to determine what types of entities to find. These hints will only be used if includeTypesFromTextClassifier(boolean) is set to be true.

Parameters
hints Collection: This value may be null.

Returns
TextClassifier.EntityConfig.Builder This value cannot be null.

setIncludedTypes

Added in API level 29
public TextClassifier.EntityConfig.Builder setIncludedTypes (Collection<String> includedTypes)

Sets a collection of types that are explicitly included.

Parameters
includedTypes Collection: This value may be null.

Returns
TextClassifier.EntityConfig.Builder This value cannot be null.