Module io.helidon.config

Package io.helidon.config.spi

Interface NodeConfigSource

All Superinterfaces:

ConfigSource, Source, Supplier<ConfigSource>

All Known Implementing Classes:

ConfigSources.SystemPropertiesConfigSource, DirectoryConfigSource, MapConfigSource, PrefixedConfigSource, SecretBundleNodeConfigSource

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 io.helidon.config.spi.Source

Source.Builder<B extends Source.Builder<B>>

Method Summary

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

Methods inherited from interface io.helidon.config.spi.ConfigSource

get, init

Methods inherited from interface io.helidon.config.spi.Source

description, exists, optional, retryPolicy

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