PrimaryKey.Algorithm


public enum PrimaryKey.Algorithm extends Enum


The PrimaryKey auto-generate algorithms.

Summary

Enum Values

AUTOINCREMENT

The PrimaryKey auto-generate algorithm that will never reuse ids over the lifetime of the database file.

ROWID

The PrimaryKey auto-generate algorithm that will reuse ids.

Public methods

final @NonNull EnumEntries<@NonNull PrimaryKey.Algorithm>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

final @NonNull PrimaryKey.Algorithm

Returns the enum constant of this type with the specified name.

final @NonNull PrimaryKey.Algorithm[]

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

Enum Values

AUTOINCREMENT

PrimaryKey.Algorithm PrimaryKey.Algorithm.AUTOINCREMENT

The PrimaryKey auto-generate algorithm that will never reuse ids over the lifetime of the database file. This algorithm is not as performant as ROWID in order to guarantee uniqueness and should be avoided unless strictly needed.

ROWID

PrimaryKey.Algorithm PrimaryKey.Algorithm.ROWID

The PrimaryKey auto-generate algorithm that will reuse ids.

Public methods

getEntries

public final @NonNull EnumEntries<@NonNull PrimaryKey.AlgorithmgetEntries()

Returns a representation of an immutable list of all enum entries, in the order they're declared.

This method may be used to iterate over the enum entries.

valueOf

Added in 3.0.0-rc01
public final @NonNull PrimaryKey.Algorithm 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.0-rc01
public final @NonNull PrimaryKey.Algorithm[] 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.