TextClassifier.EntityConfig

public static final class TextClassifier.EntityConfig
extends Object implements Parcelable

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


Configuration object for specifying what entity types to identify. Configs are initially based on a predefined preset, and can be modified from there.

Summary

Nested classes

class TextClassifier.EntityConfig.Builder

Builder class to construct the EntityConfig object. 

Inherited constants

Fields

public static final Creator<TextClassifier.EntityConfig> CREATOR

Public methods

static TextClassifier.EntityConfig create(Collection<String> hints, Collection<String> includedEntityTypes, Collection<String> excludedEntityTypes)

This method was deprecated in API level 29. Use Builder instead.

static TextClassifier.EntityConfig createWithExplicitEntityList(Collection<String> entityTypes)

This method was deprecated in API level 29. Use Builder instead.

static TextClassifier.EntityConfig createWithHints(Collection<String> hints)

This method was deprecated in API level 29. Use Builder instead.

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

Collection<String> getHints()

Retrieves the list of hints.

Collection<String> resolveEntityListModifications(Collection<String> entityTypes)

Returns a final list of entity types to find.

boolean shouldIncludeTypesFromTextClassifier()

Return whether the client allows the text classifier to include its own list of default types.

void writeToParcel(Parcel parcel, int flags)

Flatten this object in to a Parcel.

Inherited methods

Fields

CREATOR

Added in API level 28
public static final Creator<TextClassifier.EntityConfig> CREATOR

Public methods

create

Added in API level 28
Deprecated in API level 29
public static TextClassifier.EntityConfig create (Collection<String> hints, 
                Collection<String> includedEntityTypes, 
                Collection<String> excludedEntityTypes)

This method was deprecated in API level 29.
Use Builder instead.

Creates an EntityConfig.

Parameters
hints Collection: Hints for the TextClassifier to determine what types of entities to find This value may be null.

includedEntityTypes Collection: Entity types, e.g. TextClassifier.TYPE_EMAIL, to explicitly include This value may be null.

excludedEntityTypes Collection: Entity types, e.g. TextClassifier.TYPE_PHONE, to explicitly exclude Note that if an entity has been excluded, the exclusion will take precedence. This value may be null.

Returns
TextClassifier.EntityConfig

createWithExplicitEntityList

Added in API level 28
Deprecated in API level 29
public static TextClassifier.EntityConfig createWithExplicitEntityList (Collection<String> entityTypes)

This method was deprecated in API level 29.
Use Builder instead.

Creates an EntityConfig with an explicit entity list.

Parameters
entityTypes Collection: Complete set of entities, e.g. TextClassifier.TYPE_URL to find. This value may be null.

Returns
TextClassifier.EntityConfig

createWithHints

Added in API level 28
Deprecated in API level 29
public static TextClassifier.EntityConfig createWithHints (Collection<String> hints)

This method was deprecated in API level 29.
Use Builder instead.

Creates an EntityConfig.

Parameters
hints Collection: Hints for the TextClassifier to determine what types of entities to find. This value may be null.

Returns
TextClassifier.EntityConfig

describeContents

Added in API level 28
public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

getHints

Added in API level 28
public Collection<String> getHints ()

Retrieves the list of hints.

Returns
Collection<String> An unmodifiable collection of the hints.

resolveEntityListModifications

Added in API level 28
public Collection<String> resolveEntityListModifications (Collection<String> entityTypes)

Returns a final list of entity types to find.

Parameters
entityTypes Collection: Entity types we think should be found before factoring in includes/excludes This method is intended for use by TextClassifier implementations. This value cannot be null.

Returns
Collection<String>

shouldIncludeTypesFromTextClassifier

Added in API level 29
public boolean shouldIncludeTypesFromTextClassifier ()

Return whether the client allows the text classifier to include its own list of default types. If this function returns true, a default list of types suggested from a text classifier will be taking into account.

NOTE: This method is intended for use by a text classifier.

Returns
boolean

writeToParcel

Added in API level 28
public void writeToParcel (Parcel parcel, 
                int flags)

Flatten this object in to a Parcel.

Parameters
parcel Parcel: The Parcel in which the object should be written. This value cannot be null.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES