open class LazyItem<T> @JvmOverloads() constructor(spec: Spec, name: String, thunk: (config: ItemContainer) -> T, description: String, type: JavaType?, nullable: Boolean) : Item<T>

Lazy item evaluated value every time from thunk before associated with specified value.

LazyProperty

open class LazyProperty<T>(spec: Spec, thunk: (config: ItemContainer) -> T, name: String?, description: String, nullable: Boolean) : PropertyDelegateProvider<Any?, ReadOnlyProperty<Any?, LazyItem<T>>>

LeafNode

interface LeafNode : TreeNode

ListNode

interface ListNode : LeafNode

MapNode

interface MapNode : TreeNode

MergedConfig

open class MergedConfig(fallback: BaseConfig, facade: BaseConfig) : BaseConfig

Config that merge fallback and facade.

MergedMap

class MergedMap<K, V>(fallback: MutableMap<K, V>, facade: MutableMap<K, V>) : MutableMap<K, V>

NameConflictException

class NameConflictException(message: String) : ConfigException

Exception indicates that there is existed item with conflicted name in config.

NoSuchItemException

class NoSuchItemException(name: String) : ConfigException

Exception indicates that the specified item is not in this config.

NoSuchPathException

class NoSuchPathException(path: String) : ConfigException

Exception indicates that expected value in specified path is not existed in the source.

NullNode

interface NullNode : LeafNode

OptionalConfigProperty

open class OptionalConfigProperty<T>(config: Config, default: T, prefix: String, name: String?, description: String, nullable: Boolean) : PropertyDelegateProvider<Any?, ReadWriteProperty<Any?, T>>

OptionalItem

open class OptionalItem<T> @JvmOverloads() constructor(spec: Spec, name: String, default: T, description: String, type: JavaType?, nullable: Boolean) : Item<T>

Optional item with default value.

OptionalProperty

open class OptionalProperty<T>(spec: Spec, default: T, name: String?, description: String, nullable: Boolean) : PropertyDelegateProvider<Any?, ReadOnlyProperty<Any?, OptionalItem<T>>>

Path

typealias Path = List<String>

Type of Item path.

PathConflictException

class PathConflictException(path: String) : ConfigException

Exception indicates that the specified path conflicts with existed paths in the tree node.

Prefix

data class Prefix(path: String)

Convenient class for constructing Spec/Config/Source with prefix.

RepeatedInnerSpecException

class RepeatedInnerSpecException(spec: Spec) : ConfigException

Exception indicates that there is existed inner spec in config.

RepeatedItemException

class RepeatedItemException(name: String) : ConfigException

Exception indicates that there is existed item with same name in config.

RequiredConfigProperty

open class RequiredConfigProperty<T>(config: Config, prefix: String, name: String?, description: String, nullable: Boolean) : PropertyDelegateProvider<Any?, ReadWriteProperty<Any?, T>>

RequiredItem

open class RequiredItem<T> @JvmOverloads() constructor(spec: Spec, name: String, description: String, type: JavaType?, nullable: Boolean) : Item<T>

Required item without default value.

RequiredProperty

open class RequiredProperty<T>(spec: Spec, name: String?, description: String, nullable: Boolean) : PropertyDelegateProvider<Any?, ReadOnlyProperty<Any?, RequiredItem<T>>>

SizeInBytes

data class SizeInBytes(bytes: Long) : Serializable

Represents size in unit of bytes.

Spec

interface Spec

Config spec is specification for config.

TreeNode

interface TreeNode

Tree node that represents internal structure of config/source.

UnsetValueException

class UnsetValueException(name: String) : ConfigException

Exception indicates that the specified item is in unset state.

ValueNode

interface ValueNode : LeafNode

Functions

cast

inline fun <T> Config.cast(): RequiredConfigProperty<T>

Returns a property that can read/set associated value casted from config.

checkPath

fun checkPath(path: String)

createDefaultMapper

fun createDefaultMapper(): ObjectMapper

Returns a new default object mapper for config.

lazy

inline fun <T> Spec.lazy(name: String? = null, description: String = "", noinline thunk: (config: ItemContainer) -> T): LazyProperty<T>

Specify a lazy item in this config spec.

inline fun <T> Config.lazy(prefix: String = "", name: String? = null, description: String = "", noinline thunk: (config: ItemContainer) -> T): LazyConfigProperty<T>

Returns a property that can read/set associated value for specified lazy item.

notEmptyOr

fun String.notEmptyOr(default: String): String

Returns default value if string is empty, original string otherwise.

optional

inline fun <T> Spec.optional(default: T, name: String? = null, description: String = ""): OptionalProperty<T>

Specify an optional item in this config spec.

inline fun <T> Config.optional(default: T, prefix: String = "", name: String? = null, description: String = ""): OptionalConfigProperty<T>

Returns a property that can read/set associated value for specified optional item.

required

inline fun <T> Spec.required(name: String? = null, description: String = ""): RequiredProperty<T>

Specify a required item in this config spec.

inline fun <T> Config.required(prefix: String = "", name: String? = null, description: String = ""): RequiredConfigProperty<T>

Returns a property that can read/set associated value for specified required item.

tempDirectory

fun tempDirectory(prefix: String = "tmp", suffix: String? = null, directory: File? = null): File

tempFile

fun tempFile(prefix: String = "tmp", suffix: String? = null, directory: File? = null): File

toCamelCase

fun String.toCamelCase(): String

Modified implementation from org.apache.commons.text.CaseUtils.toCamelCase.

toLittleCamelCase

fun String.toLittleCamelCase(): String

toLittleCase

fun String.toLittleCase(): String

toPath

fun String.toPath(): Path

Returns corresponding item path of the item name.

toSizeInBytes

fun String.toSizeInBytes(): SizeInBytes

Converts a string to SizeInBytes.

toTree

fun Config.toTree(): TreeNode

Convert the config to a tree node.

toValue

inline fun <T> Config.toValue(): T

Returns a value casted from config.

unsupported

inline fun unsupported(): Nothing

Throws UnsupportedOperationException.

Properties

asName

val Item<*>.asName: String

emptyMutableMap

val emptyMutableMap: MutableMap<String, TreeNode>

name

val Path.name: String

Returns corresponding item name of the item path.