konstant-core/io.github.fiol_dev.konstant.core/KeyFormat

KeyFormat

enum KeyFormat : Enum<KeyFormat> (source)

How a field's property name becomes a lookup key in a ConfigSource. The examples are for the field maxPoolSize inside a nested spec held in a property named database.

Entries

SCREAMING_SNAKE

Upper case with underscores: DATABASE_MAX_POOL_SIZE. Used by environment variables.

DOT_NOTATION

Lower case with dots, including between camel-case words: database.max.pool.size. Used by the TOML, YAML, JSON and properties sources.

RAW

The property name unchanged. A nested prefix is still added in SCREAMING_SNAKE form: DATABASE_maxPoolSize, or just maxPoolSize at the top level.

Properties

entries

val entries: EnumEntries<KeyFormat>

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

name

expect val name: String

ordinal

expect val ordinal: Int

Functions

valueOf

fun valueOf(value: String): KeyFormat

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

values

fun values(): Array<KeyFormat>

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