Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Nested Classes](https://developer.android.com/reference/android/view/textclassifier/TextClassifier.EntityConfig#nestedclasses) \| [Inherited Constants](https://developer.android.com/reference/android/view/textclassifier/TextClassifier.EntityConfig#inhconstants) \| [Fields](https://developer.android.com/reference/android/view/textclassifier/TextClassifier.EntityConfig#lfields) \| [Methods](https://developer.android.com/reference/android/view/textclassifier/TextClassifier.EntityConfig#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/view/textclassifier/TextClassifier.EntityConfig#inhmethods)

# TextClassifier.EntityConfig

*** ** * ** ***

` public static final class TextClassifier.EntityConfig `   
` extends https://developer.android.com/reference/java/lang/Object ` ` implements https://developer.android.com/reference/android/os/Parcelable `

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.view.textclassifier.TextClassifier.EntityConfig |

<br />

*** ** * ** ***

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` | `https://developer.android.com/reference/android/view/textclassifier/TextClassifier.EntityConfig.Builder` Builder class to construct the `https://developer.android.com/reference/android/view/textclassifier/TextClassifier.EntityConfig` object. |

### Inherited constants

From interface `https://developer.android.com/reference/android/os/Parcelable` `int` `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR`

Descriptor bit used with `https://developer.android.com/reference/android/os/Parcelable#describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int` `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`

Flag for use with `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`".

| ### Fields ||
|---|---|
| ` public static final https://developer.android.com/reference/android/os/Parcelable.Creator<https://developer.android.com/reference/android/view/textclassifier/TextClassifier.EntityConfig>` | `https://developer.android.com/reference/android/view/textclassifier/TextClassifier.EntityConfig#CREATOR` <br /> |

| ### Public methods ||
|---|---|
| ` static https://developer.android.com/reference/android/view/textclassifier/TextClassifier.EntityConfig` | ` https://developer.android.com/reference/android/view/textclassifier/TextClassifier.EntityConfig#create(java.util.Collection<java.lang.String>,%20java.util.Collection<java.lang.String>,%20java.util.Collection<java.lang.String>)(https://developer.android.com/reference/java/util/Collection<https://developer.android.com/reference/java/lang/String> hints, https://developer.android.com/reference/java/util/Collection<https://developer.android.com/reference/java/lang/String> includedEntityTypes, https://developer.android.com/reference/java/util/Collection<https://developer.android.com/reference/java/lang/String> excludedEntityTypes) ` *This method was deprecated in API level 29. Use `https://developer.android.com/reference/android/view/textclassifier/TextClassifier.EntityConfig.Builder` instead.* |
| ` static https://developer.android.com/reference/android/view/textclassifier/TextClassifier.EntityConfig` | ` https://developer.android.com/reference/android/view/textclassifier/TextClassifier.EntityConfig#createWithExplicitEntityList(java.util.Collection<java.lang.String>)(https://developer.android.com/reference/java/util/Collection<https://developer.android.com/reference/java/lang/String> entityTypes) ` *This method was deprecated in API level 29. Use `https://developer.android.com/reference/android/view/textclassifier/TextClassifier.EntityConfig.Builder` instead.* |
| ` static https://developer.android.com/reference/android/view/textclassifier/TextClassifier.EntityConfig` | ` https://developer.android.com/reference/android/view/textclassifier/TextClassifier.EntityConfig#createWithHints(java.util.Collection<java.lang.String>)(https://developer.android.com/reference/java/util/Collection<https://developer.android.com/reference/java/lang/String> hints) ` *This method was deprecated in API level 29. Use `https://developer.android.com/reference/android/view/textclassifier/TextClassifier.EntityConfig.Builder` instead.* |
| ` int` | ` https://developer.android.com/reference/android/view/textclassifier/TextClassifier.EntityConfig#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` https://developer.android.com/reference/java/util/Collection<https://developer.android.com/reference/java/lang/String>` | ` https://developer.android.com/reference/android/view/textclassifier/TextClassifier.EntityConfig#getHints()() ` Retrieves the list of hints. |
| ` https://developer.android.com/reference/java/util/Collection<https://developer.android.com/reference/java/lang/String>` | ` https://developer.android.com/reference/android/view/textclassifier/TextClassifier.EntityConfig#resolveEntityListModifications(java.util.Collection<java.lang.String>)(https://developer.android.com/reference/java/util/Collection<https://developer.android.com/reference/java/lang/String> entityTypes) ` Returns a final list of entity types to find. |
| ` boolean` | ` https://developer.android.com/reference/android/view/textclassifier/TextClassifier.EntityConfig#shouldIncludeTypesFromTextClassifier()() ` Return whether the client allows the text classifier to include its own list of default types. |
| ` void` | ` https://developer.android.com/reference/android/view/textclassifier/TextClassifier.EntityConfig#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel parcel, int flags) ` Flatten this object in to a Parcel. |

### Inherited methods

From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `

Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class<?>` ` https://developer.android.com/reference/java/lang/Object#getClass()() `

Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `

Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `

Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `

Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `

Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(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` ` https://developer.android.com/reference/java/lang/Object#wait(long)(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` ` https://developer.android.com/reference/java/lang/Object#wait()() `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*.
From interface ` https://developer.android.com/reference/android/os/Parcelable ` ` abstract int` ` https://developer.android.com/reference/android/os/Parcelable#describeContents()() `

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
` abstract void` ` https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) `

Flatten this object in to a Parcel.

## Fields

### CREATOR

Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Creator<TextClassifier.EntityConfig> CREATOR
```

<br />

<br />

## Public methods

### create

Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)   
Deprecated in [API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

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

<br />

**This method was deprecated in API level 29.**   

Use `https://developer.android.com/reference/android/view/textclassifier/TextClassifier.EntityConfig.Builder` instead.

Creates an EntityConfig.

<br />

| Parameters ||
|---|---|
| `hints` | `Collection`: Hints for the TextClassifier to determine what types of entities to find. This value may be `null`. <br /> |
| `includedEntityTypes` | `Collection`: Entity types, e.g. `https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_EMAIL`, to explicitly include. This value may be `null`. <br /> |
| `excludedEntityTypes` | `Collection`: Entity types, e.g. `https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_PHONE`, to explicitly exclude Note that if an entity has been excluded, the exclusion will take precedence. This value may be `null`. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/view/textclassifier/TextClassifier.EntityConfig` | <br /> |

### createWithExplicitEntityList

Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)   
Deprecated in [API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

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

<br />

**This method was deprecated in API level 29.**   

Use `https://developer.android.com/reference/android/view/textclassifier/TextClassifier.EntityConfig.Builder` instead.

Creates an EntityConfig with an explicit entity list.

<br />

| Parameters ||
|---|---|
| `entityTypes` | `Collection`: Complete set of entities, e.g. `https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_URL` to find. This value may be `null`. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/view/textclassifier/TextClassifier.EntityConfig` | <br /> |

### createWithHints

Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)   
Deprecated in [API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

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

<br />

**This method was deprecated in API level 29.**   

Use `https://developer.android.com/reference/android/view/textclassifier/TextClassifier.EntityConfig.Builder` instead.

Creates an EntityConfig.

<br />

| Parameters ||
|---|---|
| `hints` | `Collection`: Hints for the TextClassifier to determine what types of entities to find. This value may be `null`. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/view/textclassifier/TextClassifier.EntityConfig` | <br /> |

### describeContents

Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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 `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`, the return value of this method must include the `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` bit.

<br />

| Returns ||
|---|---|
| `int` | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or - `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` |

### getHints

Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public Collection<String> getHints ()
```

Retrieves the list of hints.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/Collection<https://developer.android.com/reference/java/lang/String>` | An unmodifiable collection of the hints. <br /> |

### resolveEntityListModifications

Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

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

Returns a final list of entity types to find.

<br />

| 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`. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/Collection<https://developer.android.com/reference/java/lang/String>` | <br /> |

### shouldIncludeTypesFromTextClassifier

Added in [API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

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

<br />

| Returns ||
|---|---|
| `boolean` | <br /> |

**See also:**

- `https://developer.android.com/reference/android/view/textclassifier/TextClassifier.EntityConfig#resolveEntityListModifications(java.util.Collection<java.lang.String>)`

### writeToParcel

Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void writeToParcel (Parcel parcel, 
                int flags)
```

Flatten this object in to a Parcel.

<br />

| Parameters ||
|---|---|
| `parcel` | `Parcel`: The Parcel in which the object should be written. This value cannot be `null`. <br /> |
| `flags` | `int`: Additional flags about how the object should be written. May be 0 or `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` |