Module io.helidon.config

Package io.helidon.config

Class ConfigSourceRuntimeImpl

java.lang.Object

io.helidon.config.ConfigSourceRuntimeImpl

All Implemented Interfaces:

ConfigSourceRuntime, org.eclipse.microprofile.config.spi.ConfigSource

public class ConfigSourceRuntimeImpl
extends Object
implements org.eclipse.microprofile.config.spi.ConfigSource

The runtime of a config source. For a single Config, there is one source runtime for each configured config source.

Field Summary

Fields inherited from interface org.eclipse.microprofile.config.spi.ConfigSource

CONFIG_ORDINAL, DEFAULT_ORDINAL

Method Summary

Modifier and Type	Method	Description
org.eclipse.microprofile.config.spi.ConfigSource	asMpSource()	Get the underlying config source as a MicroProfile ConfigSource.
String	description()	Description of the underlying config source.
boolean	equals(Object o)
String	getName()
Map<String,String>	getProperties()
String	getValue(String propertyName)
int	hashCode()
boolean	isLazy()	If a config source is lazy, its ConfigSourceRuntime.load() method always returns empty and you must use ConfigSourceRuntime.node(String) methods to retrieve its values.
Optional<ConfigNode.ObjectNode>	load()	Load the config source if it is eager (such as ParsableSource or NodeConfigSource.
Optional<ConfigNode>	node(String key)	Get a single config node based on the key.
void	onChange(BiConsumer<String,ConfigNode> change)	Change support for a runtime.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.microprofile.config.spi.ConfigSource

getOrdinal, getPropertyNames

Method Detail

onChange

public void onChange(BiConsumer<String,ConfigNode> change)

Description copied from interface: ConfigSourceRuntime

Change support for a runtime.

Specified by:

onChange in interface ConfigSourceRuntime

Parameters:

change - change listener

load

public Optional<ConfigNode.ObjectNode> load()

Description copied from interface: ConfigSourceRuntime

Load the config source if it is eager (such as ParsableSource or NodeConfigSource.

For LazyConfigSource, this method may return an empty optional (if no key was yet requested), or a node with currently known keys and values.

Specified by:

load in interface ConfigSourceRuntime

Returns:

loaded data

isLazy

public boolean isLazy()

Description copied from interface: ConfigSourceRuntime

If a config source is lazy, its ConfigSourceRuntime.load() method always returns empty and you must use ConfigSourceRuntime.node(String) methods to retrieve its values.

Specified by:

isLazy in interface ConfigSourceRuntime

Returns:

true if the underlying config source cannot load whole configuration tree

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

node

public Optional<ConfigNode> node(String key)

Description copied from interface: ConfigSourceRuntime

Get a single config node based on the key. Use this method if you are interested in a specific key, as it works both for eager and lazy config sources.

Specified by:

node in interface ConfigSourceRuntime

Parameters:

key - key of the node to retrieve

Returns:

value on the key, or empty if not present

asMpSource

public org.eclipse.microprofile.config.spi.ConfigSource asMpSource()

Description copied from interface: ConfigSourceRuntime

Get the underlying config source as a MicroProfile ConfigSource.

Specified by:

asMpSource in interface ConfigSourceRuntime

Returns:

MP Config source

description

public String description()

Description copied from interface: ConfigSourceRuntime

Description of the underlying config source.

Specified by:

description in interface ConfigSourceRuntime

Returns:

description of the source

getProperties

public Map<String,String> getProperties()

Specified by:

getProperties in interface org.eclipse.microprofile.config.spi.ConfigSource

getValue

public String getValue(String propertyName)

Specified by:

getValue in interface org.eclipse.microprofile.config.spi.ConfigSource

getName

public String getName()

Specified by:

getName in interface org.eclipse.microprofile.config.spi.ConfigSource