Package io.helidon.config.spi

Configuration SPI that defines the behavior developers can implement to extend the config system.

The most likely developer-implemented extension points:

Common Extension Points

Interface	Purpose
ConfigSource	Loads configuration data from a type of source.
ConfigParser	Converts configuration data into a ConfigNode.ObjectNode.
ConfigFilter	Filters configuration values after they have been read from a ConfigSource but before they are used in building a Config tree.
ConfigMapperProvider	Converts Config nodes or subtrees to Java types. See ConfigMappers for the built-in mappers.
OverrideSource	Replaces values pf config nodes whose keys match specified conditions with alternative values.
PollingStrategy	Notifies interested code when the data underlying a Source might have changed.
RetryPolicy	Controls if and how a Source attempts to retry failed attempts to load the underlying data.

See Also:

Configuration API

Interface Summary

Interface	Description
Changeable<T>	Interface used to mark changeable source.
ConfigContext	Context created by a Config.Builder as it constructs a Config.
ConfigFilter	Filter that can transform elementary configuration (String) values before they are returned via the Config API.
ConfigMapper	Config mapper is provided to ConfigMapperProvider to help transformation of complex structures.
ConfigMapperProvider	Provides mapping functions that convert a Config subtree to specific Java types.
ConfigNode	Marker interface identifying a config node implementation.
ConfigNode.ListNode	ConfigNode-based list of configuration values.
ConfigNode.ListNode.Builder	Builder to build ConfigNode.ListNode instance.
ConfigNode.ObjectNode	Configuration node representing a hierarchical structure parsed by a suitable ConfigParser if necessary.
ConfigNode.ObjectNode.Builder	Builder to build ConfigNode.ObjectNode instance.
ConfigNode.ValueNode	Single string-based configuration value.
ConfigParser	Transforms config ConfigParser.Content into a ConfigNode.ObjectNode that represents the original structure and values from the content.
ConfigParser.Content<S>	ConfigSource configuration Content to be parsed into hierarchical configuration representation.
ConfigSource	Source of configuration.
OverrideSource	Source of config override settings.
PollingStrategy	Mechanism for notifying interested subscribers when they should check for changes that might have been made to the data used to create a Config tree, as accessed through ConfigSources.
PollingStrategy.PollingEvent	Event indicating that data used in constructing a given Config tree might have changed.
RetryPolicy	Mechanism for controlling retry of attempts to load data by an AbstractSource.
Source<T>	Source of the specified type <T> of data.

Class Summary

Class	Description
AbstractConfigSource<S>	Base abstract implementation of ConfigSource, suitable for concrete implementations to extend.
AbstractConfigSource.Builder<B extends AbstractConfigSource.Builder<B,T>,T>	A common ConfigSource builder ready to be extended by builder implementation related to ConfigSource extensions.
AbstractOverrideSource<S>	Base abstract implementation of OverrideSource, suitable for concrete implementations to extend.
AbstractOverrideSource.Builder<B extends AbstractOverrideSource.Builder<B,T>,T>	A common OverrideSource builder ready to be extended by builder implementation related to OverrideSource extensions.
AbstractParsableConfigSource<S>	Abstract implementation of ConfigSource that uses a ConfigParser to parse configuration content accessible as a Readable.
AbstractParsableConfigSource.Builder<B extends AbstractParsableConfigSource.Builder<B,T>,T>	Common AbstractParsableConfigSource Builder, suitable for concrete implementations of Builder that are related to ConfigSources which extend AbstractParsableConfigSource
AbstractSource<T,S>	Abstract base implementation for a variety of sources.
AbstractSource.Builder<B extends AbstractSource.Builder<B,T,S>,T,S>	A common AbstractSource builder, suitable for concrete Builder implementations related to AbstractSource extensions to extend.
AbstractSource.Data<D,S>	Data loaded at appropriate time.
OverrideSource.OverrideData	Group of config override settings.

Enum Summary

Enum	Description
ConfigNode.NodeType	Base types of config nodes.

Exception Summary

Exception	Description
ConfigParserException	Root class for exceptions thrown during config parsing.