lightbulb_outline Please take our October 2018 developer survey. Start survey

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 entities to identify. Configs are initially based on a predefined preset, and can be modified from there.

Summary

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)

Creates an EntityConfig.

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

Creates an EntityConfig with an explicit entity list.

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

Creates an EntityConfig.

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> entities)

Returns a list of the final set of entities to find.

void writeToParcel(Parcel dest, 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
public static TextClassifier.EntityConfig create (Collection<String> hints, 
                Collection<String> includedEntityTypes, 
                Collection<String> excludedEntityTypes)

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
public static TextClassifier.EntityConfig createWithExplicitEntityList (Collection<String> entityTypes)

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
public static TextClassifier.EntityConfig createWithHints (Collection<String> hints)

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(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.

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> entities)

Returns a list of the final set of entities to find.

Parameters
entities Collection: Entities we think should be found before factoring in includes/excludes This method is intended for use by TextClassifier implementations.

This value must never be null.

Returns
Collection<String>

writeToParcel

added in API level 28
public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest Parcel: The Parcel in which the object should be written.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE.