Module io.jstach.kiwi.kvs

Package io.jstach.kiwi.kvs

Class KeyValuesLoader.Builder

java.lang.Object

io.jstach.kiwi.kvs.KeyValuesLoader.Builder

All Implemented Interfaces:

KeyValuesLoader

Enclosing interface:

KeyValuesLoader

public static class KeyValuesLoader.Builder
extends Object
implements KeyValuesLoader

A builder class for constructing instances of KeyValuesLoader. The builder allows adding multiple sources from which key-values will be loaded, as well as setting variables for interpolation. Note that the order of the "add" and variables methods does matter.

Nested Class Summary

Nested classes/interfaces inherited from interface io.jstach.kiwi.kvs.KeyValuesLoader

KeyValuesLoader.Builder

Method Summary

Modifier and Type	Method	Description
KeyValuesLoader.Builder	add(KeyValuesResource resource)	Adds a KeyValuesResource as a source to the loader.
KeyValuesLoader.Builder	add(Variables variables)	Adds Variables for interpolation when loading key-values.
KeyValuesLoader.Builder	add(String uri)	Adds a URI specified as a string as a source to the loader.
KeyValuesLoader.Builder	add(String name, KeyValues keyValues)	Adds a named KeyValues source to the loader.
KeyValuesLoader.Builder	add(String uri, Consumer<KeyValuesResource.Builder> builder)	Add resource using callback on builder.
KeyValuesLoader.Builder	add(URI uri)	Adds a URI as a source by wrapping it in a KeyValuesResource.
KeyValuesLoader	build()	Builds and returns a new KeyValuesLoader based on the current state of the builder.
KeyValues	load()	Loads key-values using the current builder configuration.
KeyValuesLoader.Builder	variables(Function<KeyValuesEnvironment,Variables> variablesFactory)	Adds variables that will be resolved based on the environment.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

add

public KeyValuesLoader.Builder add(KeyValuesResource resource)

Adds a KeyValuesResource as a source to the loader.

Parameters:

resource - the resource to add

Returns:

this builder instance

add

public KeyValuesLoader.Builder add(String uri,
 Consumer<KeyValuesResource.Builder> builder)

Add resource using callback on builder.

Parameters:

uri - uri of resource

builder - builder to add additional properties.

Returns:

this.

add

public KeyValuesLoader.Builder add(String name,
 KeyValues keyValues)

Adds a named KeyValues source to the loader.

Parameters:

name - the name of the source

keyValues - the key-values to add

Returns:

this builder instance

add

public KeyValuesLoader.Builder add(URI uri)

Adds a URI as a source by wrapping it in a KeyValuesResource.

Parameters:

uri - the URI to add

Returns:

this builder instance

add

public KeyValuesLoader.Builder add(String uri)

Adds a URI specified as a string as a source to the loader.

Parameters:

uri - the URI string to add

Returns:

this builder instance

add

public KeyValuesLoader.Builder add(Variables variables)

Adds Variables for interpolation when loading key-values.

Parameters:

variables - the variables to use for interpolation

Returns:

this builder instance

variables

public KeyValuesLoader.Builder variables(Function<KeyValuesEnvironment,Variables> variablesFactory)

Adds variables that will be resolved based on the environment. Variables resolution order is the opposite of KeyValues. Primacy takes precedence! This is useful if you want to use environment things for variables that are bound to KeyValuesEnvironment. This is preferred instead of just creating Variables from System.getProperties() or System.getenv() directly.

Parameters:

variablesFactory - function to create variables from environment.

Returns:

this

See Also:

• Variables.ofSystemProperties(KeyValuesEnvironment)
• Variables.ofSystemEnv(KeyValuesEnvironment)

build

public KeyValuesLoader build()

Builds and returns a new KeyValuesLoader based on the current state of the builder.

If no sources are specified, a default classpath resource classpath:/system.properties is used.

Returns:

a new KeyValuesLoader instance

load

public KeyValues load()
               throws IOException,
FileNotFoundException

Loads key-values using the current builder configuration.

Specified by:

load in interface KeyValuesLoader

Returns:

a KeyValues instance containing the loaded key-value pairs

Throws:

IOException - if an I/O error occurs during loading

FileNotFoundException - if a specified resource is not found