Class MapConfigSource

java.lang.Object

io.helidon.config.AbstractSource

io.helidon.config.AbstractConfigSource

io.helidon.config.MapConfigSource

All Implemented Interfaces:

ConfigSource, NodeConfigSource, PollableSource<Map<?,?>>, Source, Supplier<ConfigSource>

Direct Known Subclasses:

ConfigSources.SystemPropertiesConfigSource

public class MapConfigSource
extends AbstractConfigSource
implements ConfigSource, NodeConfigSource, PollableSource<Map<?,?>>

ConfigSource implementation based on Map<String, String>.

Map key format must conform to Config key format.

See Also:

• MapConfigSource.Builder

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MapConfigSource.Builder	Fluent API builder for MapConfigSource.
static class	MapConfigSource.MapBuilder<T extends MapConfigSource.MapBuilder<T>>	An abstract fluent API builder for MapConfigSource.

Method Summary

Modifier and Type	Method	Description
static MapConfigSource.Builder	builder()	Create a new fluent API builder.
static MapConfigSource	create(Map<String,String> map)	Create a new config source from the provided map.
static MapConfigSource	create(Properties properties)	Create a new config source from the provided properties.
boolean	isModified(Map<?,?> stamp)	This method is invoked to check if this source has changed.
Optional<ConfigContent.NodeContent>	load()	Loads the underlying source data.
Optional<PollingStrategy>	pollingStrategy()	A polling strategy of this source, if it implements PollableSource and has one configured.
protected String	uid()	Returns universal id of source to be used to construct AbstractSource.description().

Methods inherited from class AbstractConfigSource

mediaType, parser, toString

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, retryPolicy

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.
Optional<RetryPolicy>	retryPolicy()	Retry policy configured on this config source.

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.

Method Details

builder

public static MapConfigSource.Builder builder()

Create a new fluent API builder.

Returns:

a new builder instance

create

public static MapConfigSource create(Map<String,String> map)

Create a new config source from the provided map.

Parameters:

map - config properties

Returns:

a new map config source

create

public static MapConfigSource create(Properties properties)

Create a new config source from the provided properties.

Parameters:

properties - properties to serve as source of data

Returns:

a new map config source

isModified

public boolean isModified(Map<?,?> stamp)

Description copied from interface: PollableSource

This method is invoked to check if this source has changed.

Specified by:

isModified in interface PollableSource<Map<?,?>>

Parameters:

stamp - the stamp of the last loaded content

Returns:

true if the current data of this config source differ from the loaded data, including cases when the source has disappeared

pollingStrategy

public Optional<PollingStrategy> pollingStrategy()

Description copied from class: AbstractSource

A polling strategy of this source, if it implements PollableSource and has one configured.

Specified by:

pollingStrategy in interface PollableSource<Map<?,?>>

Overrides:

pollingStrategy in class AbstractSource

Returns:

polling strategy if any configured

load

public Optional<ConfigContent.NodeContent> load()
                                         throws ConfigException

Description copied from interface: NodeConfigSource

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.

Specified by:

load in interface NodeConfigSource

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

uid

protected String uid()

Description copied from class: AbstractSource

Returns universal id of source to be used to construct AbstractSource.description().

Overrides:

uid in class AbstractSource

Returns:

universal id of source