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

FieldDescriptor

class FieldDescriptor<T>(val propertyName: String, val typeName: String, val secret: Boolean, val default: T?, val hasDefault: Boolean, val customKey: String? = null, val convert: (String) -> T, val convertChildren: (Map<String, String>) -> T? = null, val validate: (T) -> String?? = null)(source)

Describes one config field for ConfigLoader.resolve. Built by generated code.

Constructors

FieldDescriptor

constructor(propertyName: String, typeName: String, secret: Boolean, default: T?, hasDefault: Boolean, customKey: String? = null, convert: (String) -> T, convertChildren: (Map<String, String>) -> T? = null, validate: (T) -> String?? = null)

Properties

val convert: (String) -> T

Converts the raw text; throws on invalid input.

convertChildren

val convertChildren: (Map<String, String>) -> T?

Builds the value from ConfigSource.children when the key itself is absent (Map fields).

val customKey: String?

The @Key name, used instead of a derived key.

val default: T?

The value used when no source has the key, if hasDefault.

val hasDefault: Boolean

Whether the field is optional: it has a default or is nullable.

val propertyName: String

The property name in the spec, e.g. maxPoolSize.

val secret: Boolean

True for a @Secret field, whose value is shown as ***.

val typeName: String

The type shown in ConfigError.ConversionFailed.targetType.

val validate: (T) -> String??

Returns an error message when a converted value breaks a validation annotation.