Added in [API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [XML Attrs](https://developer.android.com/reference/android/view/textservice/SpellCheckerSubtype#lattrs) \| [Inherited Constants](https://developer.android.com/reference/android/view/textservice/SpellCheckerSubtype#inhconstants) \| [Fields](https://developer.android.com/reference/android/view/textservice/SpellCheckerSubtype#lfields) \| [Ctors](https://developer.android.com/reference/android/view/textservice/SpellCheckerSubtype#pubctors) \| [Methods](https://developer.android.com/reference/android/view/textservice/SpellCheckerSubtype#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/view/textservice/SpellCheckerSubtype#inhmethods)

# SpellCheckerSubtype

*** ** * ** ***


`
public

final

class
SpellCheckerSubtype
`


`

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.textservice.SpellCheckerSubtype |

<br />

*** ** * ** ***

This class is used to specify meta information of a subtype contained in a spell checker.
Subtype can describe locale (e.g. en_US, fr_FR...) used for settings.
**See also:**

- `https://developer.android.com/reference/android/view/textservice/SpellCheckerInfo`

## Summary

| ### XML attributes ||
|---|---|
| [`android:label`](https://developer.android.com/reference/android/view/textservice/SpellCheckerSubtype#attr_android:label) | The name of the subtype. |
| [`android:languageTag`](https://developer.android.com/reference/android/view/textservice/SpellCheckerSubtype#attr_android:languageTag) | The BCP-47 Language Tag of the subtype. |
| [`android:subtypeExtraValue`](https://developer.android.com/reference/android/view/textservice/SpellCheckerSubtype#attr_android:subtypeExtraValue) | The extra value of the subtype. |
| [`android:subtypeId`](https://developer.android.com/reference/android/view/textservice/SpellCheckerSubtype#attr_android:subtypeId) | The unique id for the subtype. |
| [`android:subtypeLocale`](https://developer.android.com/reference/android/view/textservice/SpellCheckerSubtype#attr_android:subtypeLocale) | The locale of the subtype. |

| ### 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/textservice/SpellCheckerSubtype>` | `https://developer.android.com/reference/android/view/textservice/SpellCheckerSubtype#CREATOR` |

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/android/view/textservice/SpellCheckerSubtype#SpellCheckerSubtype(int,%20java.lang.String,%20java.lang.String)(int nameId, https://developer.android.com/reference/java/lang/String locale, https://developer.android.com/reference/java/lang/String extraValue) ` *This constructor is deprecated. There is no public API that requires developers to directly instantiate custom `https://developer.android.com/reference/android/view/textservice/SpellCheckerSubtype` objects right now. Hence only the system is expected to be able to instantiate `https://developer.android.com/reference/android/view/textservice/SpellCheckerSubtype` object.* |

| ### Public methods ||
|---|---|
| ` boolean` | ` https://developer.android.com/reference/android/view/textservice/SpellCheckerSubtype#containsExtraValueKey(java.lang.String)(https://developer.android.com/reference/java/lang/String key) ` The string of ExtraValue in subtype should be defined as follows: example: key0,key1=value1,key2,key3,key4=value4 |
| ` int` | ` https://developer.android.com/reference/android/view/textservice/SpellCheckerSubtype#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` boolean` | ` https://developer.android.com/reference/android/view/textservice/SpellCheckerSubtype#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object o) ` Indicates whether some other object is "equal to" this one. |
| ` https://developer.android.com/reference/java/lang/CharSequence` | ` https://developer.android.com/reference/android/view/textservice/SpellCheckerSubtype#getDisplayName(android.content.Context,%20java.lang.String,%20android.content.pm.ApplicationInfo)(https://developer.android.com/reference/android/content/Context context, https://developer.android.com/reference/java/lang/String packageName, https://developer.android.com/reference/android/content/pm/ApplicationInfo appInfo) ` |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/view/textservice/SpellCheckerSubtype#getExtraValue()() ` |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/view/textservice/SpellCheckerSubtype#getExtraValueOf(java.lang.String)(https://developer.android.com/reference/java/lang/String key) ` The string of ExtraValue in subtype should be defined as follows: example: key0,key1=value1,key2,key3,key4=value4 |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/view/textservice/SpellCheckerSubtype#getLanguageTag()() ` |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/view/textservice/SpellCheckerSubtype#getLocale()() ` *This method was deprecated in API level 24. Use `https://developer.android.com/reference/android/view/textservice/SpellCheckerSubtype#getLanguageTag()` instead.* |
| ` int` | ` https://developer.android.com/reference/android/view/textservice/SpellCheckerSubtype#getNameResId()() ` |
| ` int` | ` https://developer.android.com/reference/android/view/textservice/SpellCheckerSubtype#hashCode()() ` Returns a hash code value for the object. |
| ` void` | ` https://developer.android.com/reference/android/view/textservice/SpellCheckerSubtype#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int parcelableFlags) ` 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. | ||

## XML attributes

### android:label

The name of the subtype.

May be a reference to another resource, in the form
"`@[+][*package*:]*type*/*name*`" or a theme
attribute in the form
"`?[*package*:]*type*/*name*`".

May be a string value, using '\\\\;' to escape characters such as
'\\\\n' or '\\\\uxxxx' for a unicode character;

<br />

### android:languageTag

The BCP-47 Language Tag of the subtype. This replaces
`https://developer.android.com/reference/android/R.styleable#SpellChecker_Subtype_subtypeLocale`.

May be a string value, using '\\\\;' to escape characters such as
'\\\\n' or '\\\\uxxxx' for a unicode character;

<br />

### android:subtypeExtraValue

The extra value of the subtype. This string can be any string and will be passed to
the SpellChecker.

May be a string value, using '\\\\;' to escape characters such as
'\\\\n' or '\\\\uxxxx' for a unicode character;

<br />

### android:subtypeId

The unique id for the subtype. The text service (spell checker) framework keeps track
of enabled subtypes by ID. When the spell checker package gets upgraded, enabled IDs
will stay enabled even if other attributes are different. If the ID is unspecified or
explicitly specified to 0 in XML resources,
`Arrays.hashCode(new Object[] {subtypeLocale, extraValue})` will be used instead.

May be an integer value, such as "`100`".

<br />

### android:subtypeLocale

The locale of the subtype. This string should be a locale (for example, en_US and
fr_FR). This is also used by the framework to know the supported locales
of the spell checker. `https://developer.android.com/reference/android/view/textservice/SpellCheckerSubtype#getLocale()`
returns the value specified in this attribute.

May be a string value, using '\\\\;' to escape characters such as
'\\\\n' or '\\\\uxxxx' for a unicode character;

<br />

## Fields

### CREATOR

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

```
public static final Creator<SpellCheckerSubtype> CREATOR
```

<br />

<br />

## Public constructors

### SpellCheckerSubtype

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

```
public SpellCheckerSubtype (int nameId, 
                String locale, 
                String extraValue)
```


**This constructor is deprecated.**   

There is no public API that requires developers to directly instantiate custom
`https://developer.android.com/reference/android/view/textservice/SpellCheckerSubtype` objects right now. Hence only the system is expected to be able
to instantiate `https://developer.android.com/reference/android/view/textservice/SpellCheckerSubtype` object.

Constructor.

<br />

| Parameters ||
|---|---|
| `nameId` | `int`: The name of the subtype <br /> |
| `locale` | `String`: The locale supported by the subtype <br /> |
| `extraValue` | `String`: The extra value of the subtype <br /> |

## Public methods

### containsExtraValueKey

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

```
public boolean containsExtraValueKey (String key)
```

The string of ExtraValue in subtype should be defined as follows:
example: key0,key1=value1,key2,key3,key4=value4

<br />

| Parameters ||
|---|---|
| `key` | `String`: the key of extra value <br /> |

| Returns ||
|---|---|
| `boolean` | the subtype contains specified the extra value <br /> |

### describeContents

Added in [API level 14](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` |

### equals

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

```
public boolean equals (Object o)
```

Indicates whether some other object is "equal to" this one.


The `equals` method implements an equivalence relation
on non-null object references:

- It is *reflexive*: for any non-null reference value `x`, `x.equals(x)` should return `true`.
- It is *symmetric*: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`.
- It is *transitive*: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`.
- It is *consistent*: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified.
- For any non-null reference value `x`, `x.equals(null)` should return `false`.


An equivalence relation partitions the elements it operates on
into *equivalence classes*; all the members of an
equivalence class are equal to each other. Members of an
equivalence class are substitutable for each other, at least
for some purposes.

<br />

| Parameters ||
|---|---|
| `o` | `Object`: This value may be `null`. <br /> |

| Returns ||
|---|---|
| `boolean` | `true` if this object is the same as the obj argument; `false` otherwise. <br /> |

### getDisplayName

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

```
public CharSequence getDisplayName (Context context, 
                String packageName, 
                ApplicationInfo appInfo)
```

<br />

<br />

| Parameters ||
|---|---|
| `context` | `Context`: Context will be used for getting Locale and PackageManager. <br /> |
| `packageName` | `String`: The package name of the spell checker <br /> |
| `appInfo` | `ApplicationInfo`: The application info of the spell checker <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/CharSequence` | a display name for this subtype. The string resource of the label (mSubtypeNameResId) can have only one %s in it. If there is, the %s part will be replaced with the locale's display name by the formatter. If there is not, this method simply returns the string specified by mSubtypeNameResId. If mSubtypeNameResId is not specified (== 0), it's up to the framework to generate an appropriate display name. <br /> |

### getExtraValue

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

```
public String getExtraValue ()
```

<br />

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | the extra value of the subtype <br /> |

### getExtraValueOf

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

```
public String getExtraValueOf (String key)
```

The string of ExtraValue in subtype should be defined as follows:
example: key0,key1=value1,key2,key3,key4=value4

<br />

| Parameters ||
|---|---|
| `key` | `String`: the key of extra value <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | the value of the specified key <br /> |

### getLanguageTag

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

```
public String getLanguageTag ()
```

<br />

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | the BCP-47 Language Tag of the subtype. Returns an empty string when no Language Tag is specified. This value cannot be `null`. <br /> |

**See also:**

- `https://developer.android.com/reference/java/util/Locale#forLanguageTag(java.lang.String)`

### getLocale

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

```
public String getLocale ()
```


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

Use `https://developer.android.com/reference/android/view/textservice/SpellCheckerSubtype#getLanguageTag()` instead.

<br />

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | the locale of the subtype. This value cannot be `null`. <br /> |

### getNameResId

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

```
public int getNameResId ()
```

<br />

<br />

| Returns ||
|---|---|
| `int` | the name of the subtype <br /> |

### hashCode

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

```
public int hashCode ()
```

Returns a hash code value for the object. This method is
supported for the benefit of hash tables such as those provided by
`https://developer.android.com/reference/java/util/HashMap`.


The general contract of `hashCode` is:

- Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
- If two objects are equal according to the `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` method, then calling the `hashCode` method on each of the two objects must produce the same integer result.
- It is *not* required that if two objects are unequal according to the `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

<br />

<br />

| Returns ||
|---|---|
| `int` | a hash code value for this object. <br /> |

### writeToParcel

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

```
public void writeToParcel (Parcel dest, 
                int parcelableFlags)
```

Flatten this object in to a Parcel.

<br />

| Parameters ||
|---|---|
| `dest` | `Parcel`: The Parcel in which the object should be written. This value cannot be `null`. <br /> |
| `parcelableFlags` | `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` |