FtsOptions.Detail

Added in 3.0.1

Kotlin |Java

public enum FtsOptions.Detail extends Enum

java.lang.Object
↳	kotlin.Enum
	↳	androidx.room3.FtsOptions.Detail

Summary

Enum Values
`COLUMN`	Only the row id and the column it appears in is stored.
`FULL`	All information is stored in the FTS index.
`NONE`	Only the row id is stored.

Public methods
`final @NonNull EnumEntries<@NonNull FtsOptions.Detail>`	`getEntries()` Returns an immutable `kotlin.enums.EnumEntries` list containing the constants of this enum type, in the order they're declared.
`static final @NonNull FtsOptions.Detail`	`valueOf(@NonNull String value)` Returns the enum constant of this type with the specified name.
`static final @NonNull FtsOptions.Detail[]`	`values()` Returns an array containing the constants of this enum type, in the order they're declared.

Enum Values

COLUMN

FtsOptions.Detail FtsOptions.Detail.COLUMN

Only the row id and the column it appears in is stored.

See also
`detail`

FULL

FtsOptions.Detail FtsOptions.Detail.FULL

All information is stored in the FTS index.

See also
`detail`

NONE

FtsOptions.Detail FtsOptions.Detail.NONE

Only the row id is stored.

See also
`detail`

Public methods

getEntries

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

Returns an immutable kotlin.enums.EnumEntries list containing the constants of this enum type, in the order they're declared.

valueOf

Added in 3.0.1

public static final @NonNull FtsOptions.Detail 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
`kotlin.IllegalArgumentException`	if this enum type has no constant with the specified name

values

Added in 3.0.1

public static final @NonNull FtsOptions.Detail[] 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.