Interface NodeConfigSource

All Superinterfaces:

ConfigSource, Source, Supplier<ConfigSource>

All Known Implementing Classes:

ConfigSources.SystemPropertiesConfigSource, DirectoryConfigSource, MapConfigSource, PrefixedConfigSource

public interface NodeConfigSource
extends ConfigSource

An eager source that can read all data from the underlying origin as a configuration node.

Nested Class Summary

Nested classes/interfaces inherited from interface Source

Source.Builder<B>

Modifier and Type	Interface	Description
static interface	Source.Builder<B extends Source.Builder<B>>	Configurable options of a Source.

Method Summary

Modifier and Type	Method	Description
Optional<ConfigContent.NodeContent>	load()	Loads the underlying source data.

Methods inherited from interface ConfigSource

get, init

Modifier and Type	Method	Description
default ConfigSource	get()
default void	init(ConfigContext context)	Initialize the config source with a ConfigContext.

Methods inherited from interface Source

description, exists, optional, retryPolicy

Modifier and Type	Method	Description
default String	description()	Short, human-readable summary referring to the underlying source.
default boolean	exists()	If the underlying data exist at this time.
default boolean	optional()	Whether this source is optional.
default Optional<RetryPolicy>	retryPolicy()	Retry policy configured on this config source.

Method Details

load

Optional<ConfigContent.NodeContent> load()
                                  throws ConfigException

Loads the underlying source data. This method is only called when the source Source.exists().

The method can be invoked repeatedly, for example during retries.

Returns:

An instance of T as read from the underlying origin of the data (if it exists)

Throws:

ConfigException - in case of errors loading from the underlying origin