Package com.uchuhimo.konf.source

Types

BaseSource

open class BaseSource(info: SourceInfo, tree: TreeNode, features: Map<Feature, Boolean>) : Source

DefaultLoaders

class DefaultLoaders(config: Config, transform: (Source) -> Source?)

Default loaders for config.

DefaultMapProviders

object DefaultMapProviders

Providers for map of variant formats.

DefaultProviders

object DefaultProviders

Default providers.

InvalidRemoteRepoException

class InvalidRemoteRepoException(repo: String, dir: String) : SourceException

Exception indicates that the given repository is not in the remote list of the local repository.

InvalidWatchKeyException

class InvalidWatchKeyException(source: Source) : SourceException

Exception indicates that watch key is no longer valid for the source.

ListSourceNode

open class ListSourceNode(list: List<TreeNode>, isPlaceHolder: Boolean) : ListNode, MapNode

Loader

class Loader(config: Config, provider: Provider)

Loader to load source from various input formats.

LoadException

class LoadException(path: Path, cause: Throwable) : SourceException

Exception indicates failure to load specified path.

MapLoader

class MapLoader(config: Config, transform: (Source) -> Source?)

Loader to load source from map of variant formats.

MergedSource

class MergedSource(facade: Source, fallback: Source) : Source

NoSuchPathException

class NoSuchPathException(source: Source, path: Path) : SourceException

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

NullSourceNode

object NullSourceNode : NullNode

ObjectMappingException

class ObjectMappingException(source: String, clazz: Class<*>, cause: Throwable) : SourceException

Exception indicates failure to map source to value of specified class.

ParseException

class ParseException : SourceException

Exception indicates that there is a parsing error.

PromoteFunc

typealias PromoteFunc<Out> = (Any, Source) -> Out

Provider

interface Provider

Provides source from various input format.

RegisterExtension

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class RegisterExtension(value: Array<String>)

Source

interface Source

Source to provide values for config.

SourceException

open class SourceException : ConfigException

Exception for source.

SourceInfo

class SourceInfo(info: MutableMap<String, String>) : MutableMap<String, String>

Information of source for debugging.

SourceNotFoundException

class SourceNotFoundException(message: String) : SourceException

Exception indicates that specified source is not found.

SubstitutableNode

interface SubstitutableNode : ValueNode

TreeLookup

class TreeLookup(root: TreeNode, source: Source, errorWhenUndefined: Boolean) : StringLookup

UndefinedPathVariableException

class UndefinedPathVariableException(source: Source, text: String) : SourceException

Exception indicates that undefined paths occur during variable substitution.

UnknownPathsException

class UnknownPathsException(source: Source, paths: List<String>) : SourceException

Exception indicates that the source contains unknown paths.

UnsupportedExtensionException

class UnsupportedExtensionException(source: String) : SourceException

Exception indicates that specified source has unsupported extension.

UnsupportedMapKeyException

class UnsupportedMapKeyException(clazz: Class<*>) : SourceException

Exception indicates that value of specified class is unsupported as key of map.

UnsupportedNodeTypeException

class UnsupportedNodeTypeException(source: Source, node: TreeNode) : SourceException

Exception indicates that the specified node has unsupported type.

UnsupportedTypeException

class UnsupportedTypeException(source: Source, clazz: Class<*>) : SourceException

Exception indicates that value of specified class in unsupported in the source.

ValueSourceNode

class ValueSourceNode(value: Any, substituted: Boolean, originalValue: Any?) : SubstitutableNode

Writer

interface Writer

Save config to various output format.

WrongTypeException

class WrongTypeException(source: String, actual: String, expected: String) : SourceException

Exception indicates that actual type of value in source is unmatched with expected type.

Functions

asSource

fun Any.asSource(type: String = "", info: SourceInfo = SourceInfo()): Source

asTree

fun Any.asTree(): TreeNode

asValue

inline fun <T> Source.asValue(): T

asValueOf

fun TreeNode.asValueOf(source: Source, type: Class<*>): Any

toDuration

fun String.toDuration(): Duration

Parses specified string to duration.

toValue

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

Returns a value casted from source.