Package io.helidon.config.spi

Class AbstractConfigSource<S>

java.lang.Object

io.helidon.config.spi.AbstractSource<ConfigNode.ObjectNode,S>

io.helidon.config.spi.AbstractConfigSource<S>

Type Parameters:

S - a type of data stamp

All Implemented Interfaces:

Changeable<S>, ConfigSource, Source<S>, java.lang.AutoCloseable, java.util.function.Supplier<S>

Direct Known Subclasses:

AbstractParsableConfigSource

public abstract class AbstractConfigSource<S>
extends AbstractSource<ConfigNode.ObjectNode,S>
implements ConfigSource

Base abstract implementation of ConfigSource, suitable for concrete implementations to extend.

See Also:

AbstractConfigSource.Builder

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractConfigSource.Builder<B extends AbstractConfigSource.Builder<B,T>,T>	A common ConfigSource builder ready to be extended by builder implementation related to ConfigSource extensions.

Nested classes/interfaces inherited from class io.helidon.config.spi.AbstractSource

AbstractSource.Data<D,S>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractConfigSource(AbstractConfigSource.Builder<?,?> builder)	Initializes config source from builder.

Method Summary

Modifier and Type	Method	Description
Flow.Publisher<java.util.Optional<ConfigNode.ObjectNode>>	changes()	Returns a Flow.Publisher to which the caller can subscribe in order to receive change notifications.
protected ConfigContext	getConfigContext()
void	init(ConfigContext context)	Initialize the config source with a ConfigContext.
protected AbstractSource.Data<ConfigNode.ObjectNode,S>	processLoadedData(AbstractSource.Data<ConfigNode.ObjectNode,S> data)	Performs any postprocessing of config data after loading.

Methods inherited from class io.helidon.config.spi.AbstractSource

dataStamp, description, fireChangeEvent, isMandatory, load, loadData, uid

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

from, get

Methods inherited from class java.lang.Object

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

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

close, description, load

Constructor Detail

AbstractConfigSource

protected AbstractConfigSource(AbstractConfigSource.Builder<?,?> builder)

Initializes config source from builder.

Parameters:

builder - builder to be initialized from

Method Detail

init

public final void init(ConfigContext context)

Description copied from interface: ConfigSource

Initialize the config source with a ConfigContext.

The method is executed during Config bootstrapping by Config.Builder.

Specified by:

init in interface ConfigSource

Parameters:

context - a config context

getConfigContext

protected ConfigContext getConfigContext()

processLoadedData

protected AbstractSource.Data<ConfigNode.ObjectNode,S> processLoadedData(AbstractSource.Data<ConfigNode.ObjectNode,S> data)

Description copied from class: AbstractSource

Performs any postprocessing of config data after loading. By default, the method simply returns the provided input Data.

Overrides:

processLoadedData in class AbstractSource<ConfigNode.ObjectNode,S>

Parameters:

data - an input data

Returns:

a post-processed data

changes

public final Flow.Publisher<java.util.Optional<ConfigNode.ObjectNode>> changes()

Returns a Flow.Publisher to which the caller can subscribe in order to receive change notifications.

Method Flow.Subscriber.onError(Throwable) is called in case of error listening on config source data. Method Flow.Subscriber.onComplete() is never called.

All subscribers are notified using specified executor.

Specified by:

changes in interface Changeable<S>

Specified by:

changes in interface Source<S>

Returns:

a publisher of events. Never returns null