# FtsOptions.MatchInfo

Artifact: [androidx.room:room-common](https://developer.android.com/jetpack/androidx/releases/room) [View Source](https://cs.android.com/search?q=file:androidx/room/FtsOptions.kt+class:androidx.room.FtsOptions.MatchInfo) Added in [2.1.0](https://developer.android.com/jetpack/androidx/releases/room#2.1.0)

*** ** * ** ***


```
public enum FtsOptions.MatchInfo extends Enum<@NonNull FtsOptions.MatchInfo>
```

<br />

|---|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object.html) |||
| ↳ | [kotlin.Enum](https://developer.android.com/reference/java/lang/Enum.html)\<@[NonNull](https://developer.android.com/reference/androidx/annotation/NonNull) [FtsOptions.MatchInfo](https://developer.android.com/reference/androidx/room/FtsOptions.MatchInfo)\> ||
|   | ↳ | [androidx.room.FtsOptions.MatchInfo](https://developer.android.com/reference/androidx/room/FtsOptions.MatchInfo) |

*** ** * ** ***

## Summary

| ### Enum Values |
|---|---|
| `https://developer.android.com/reference/androidx/room/FtsOptions.MatchInfo#FTS3` | Text matching info as version 3 of the extension module. |
| `https://developer.android.com/reference/androidx/room/FtsOptions.MatchInfo#FTS4` | Text matching info as version 4 of the extension module. |

| ### Public methods |
|---|---|
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.enums/-enum-entries/index.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/room/FtsOptions.MatchInfo>` | `https://developer.android.com/reference/androidx/room/FtsOptions.MatchInfo#getEntries()()` Returns an immutable `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.enums/-enum-entries/index.html` list containing the constants of this enum type, in the order they're declared. |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/room/FtsOptions.MatchInfo` | `https://developer.android.com/reference/androidx/room/FtsOptions.MatchInfo#valueOf(kotlin.String)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html value)` Returns the enum constant of this type with the specified name. |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull FtsOptions.MatchInfo[]` | `https://developer.android.com/reference/androidx/room/FtsOptions.MatchInfo#values()()` Returns an array containing the constants of this enum type, in the order they're declared. |

## Enum Values

### FTS3

```
FtsOptions.MatchInfo FtsOptions.MatchInfo.FTS3
```

Text matching info as version 3 of the extension module.

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/room/Fts4#matchInfo()` |   |

### FTS4

```
FtsOptions.MatchInfo FtsOptions.MatchInfo.FTS4
```

Text matching info as version 4 of the extension module.

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/room/Fts4#matchInfo()` |   |

## Public methods

### getEntries

```
public final @NonNull EnumEntries<@NonNull FtsOptions.MatchInfo> getEntries()
```

Returns an immutable `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.enums/-enum-entries/index.html` list containing the constants of this enum type, in the order they're declared.

### valueOf

Added in [2.1.0](https://developer.android.com/jetpack/androidx/releases/room#2.1.0)

```
public static final @NonNull FtsOptions.MatchInfo valueOf(@NonNull String value)
```

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

| Throws |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-argument-exception/index.html` | if this enum type has no constant with the specified name |

### values

Added in [2.1.0](https://developer.android.com/jetpack/androidx/releases/room#2.1.0)

```
public static final @NonNull FtsOptions.MatchInfo[] values()
```

Returns an array containing the constants of this enum type, in the order they're declared.

This method may be used to iterate over the constants.

The function returns a new instance of the array on every call. The array could be mutated, so working with it may also require defensive copying. Consider using `entries` property as a more efficient alternative returning an immutable list of enum entries.