spi/me.ahoo.wow.spi.config/ProviderOption/Companion

Companion

object Companion

Functions

boolean

@JvmStatic

fun boolean(key: String, description: String): ProviderOption<Boolean>

true or false, missing when it is not set.

@JvmStatic

fun boolean(key: String, description: String, default: Boolean): ProviderOption.Defaulted<Boolean>

true or false, default when it is not set.

duration

@JvmStatic

fun duration(key: String, description: String): ProviderOption<Duration>

A duration, written as Kotlin writes one (500ms, 5s, 1m 30s), in ISO-8601 (PT5S), or as a bare number of milliseconds (500), as a Spring Duration property reads it; missing when it is not set.

@JvmStatic

fun duration(key: String, description: String, default: Duration): ProviderOption.Defaulted<Duration>

A duration, as duration reads one, default when it is not set.

enumeration

@JvmStatic

fun <E : Enum<E>> enumeration(key: String, description: String, type: Class<E>): ProviderOption<E>

One of the constants of type, written as the configuration writes a value: lower case, words joined by dashes (WAIT_FOR is wait-for); missing when it is not set.

@JvmStatic

fun <E : Enum<E>> enumeration(key: String, description: String, type: Class<E>, default: E): ProviderOption.Defaulted<E>

One of the constants of type, as enumeration reads one, default when it is not set.

int

@JvmStatic

fun int(key: String, description: String): ProviderOption<Int>

A whole number, missing when it is not set.

@JvmStatic

fun int(key: String, description: String, default: Int): ProviderOption.Defaulted<Int>

A whole number, default when it is not set.

map

@JvmStatic

fun map(prefix: String, description: String): ProviderOption<Map<String, String>>

The settings under prefix, each sub-key passed through as it is (a client's properties.*, a server's settings.*): any sub-key is accepted, none is checked.

string

@JvmStatic

fun string(key: String, description: String): ProviderOption<String>

A text setting, missing when it is not set.

@JvmStatic

fun string(key: String, description: String, default: String): ProviderOption.Defaulted<String>

A text setting, default when it is not set.

valueOf

@JvmStatic

fun valueOf(constant: Enum<*>): String

constant as the configuration writes it: lower case, words joined by dashes.