Class AbstractConfigSource

java.lang.Object

io.helidon.config.AbstractSource

io.helidon.config.AbstractConfigSource

All Implemented Interfaces:

ConfigSource, Source, Supplier<ConfigSource>

Direct Known Subclasses:

ClasspathConfigSource, DirectoryConfigSource, FileConfigSource, MapConfigSource, UrlConfigSource

public abstract class AbstractConfigSource
extends AbstractSource
implements ConfigSource

A base implementation for config sources, that combines configuration from any type of a config source. This class does not directly implement the interfaces - this is left to the implementer of the config source. This class provides configuration methods as protected, so you can make them public in your implementation, to only expose methods that must be implemented.

Other methods of the config source interfaces must be implemented by each source as they are data specific, such as PollableSource.isModified(Object). All other methods return reasonable defaults. Config framework analyzes the config source based on interfaces it implements.

See Also:

• ConfigSource
• WatchableSource
• PollableSource
• ParsableSource

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.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractConfigSource(AbstractConfigSourceBuilder<?,?> builder)	Use common data from the builder to setup media type, parser, media type mapping, and parser mapping on this instance.

Method Summary

Modifier and Type	Method	Description
protected Optional<MediaType>	mediaType()	Media type if on eis configured for parsing content of ParsableSource.
protected Optional<ConfigParser>	parser()	Config parser if one is configured to use for parsing content of ParsableSource.
String	toString()

Methods inherited from class AbstractSource

changeWatcher, description, optional, pollingStrategy, retryPolicy, uid

Modifier and Type	Method	Description
protected Optional<ChangeWatcher<Object>>	changeWatcher()	A change watcher of this source, if it implements WatchableSource and has one configured.
String	description()	Short, human-readable summary referring to the underlying source.
boolean	optional()	Whether this source is optional.
protected Optional<PollingStrategy>	pollingStrategy()	A polling strategy of this source, if it implements PollableSource and has one configured.
Optional<RetryPolicy>	retryPolicy()	Retry policy configured on this config source.
protected String	uid()	Returns universal id of source to be used to construct AbstractSource.description().

Methods inherited from class Object

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

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

exists

Modifier and Type	Method	Description
default boolean	exists()	If the underlying data exist at this time.

Constructor Details

AbstractConfigSource

protected AbstractConfigSource(AbstractConfigSourceBuilder<?,?> builder)

Use common data from the builder to setup media type, parser, media type mapping, and parser mapping on this instance. Additional common data is handled by AbstractSource(AbstractSourceBuilder).

Parameters:

builder - builder used to set up this config source

Method Details

mediaType

protected Optional<MediaType> mediaType()

Media type if on eis configured for parsing content of ParsableSource. If there is none configured (default), a parser is chosen based on ConfigParser.Content.mediaType() - media type detected during load of data.

Returns:

configured media type or empty if none configured

parser

protected Optional<ConfigParser> parser()

Config parser if one is configured to use for parsing content of ParsableSource. If one is not configured on a source (default), a parser is chosen based on mediaType().

Returns:

a configured parser, or empty if one should be chosen from media type (or if this is not a parsable source)

toString

public String toString()

Overrides:

toString in class Object