Class MapConfigSource.MapBuilder<T extends MapConfigSource.MapBuilder<T>>

java.lang.Object

io.helidon.config.AbstractSourceBuilder<T,Void>

io.helidon.config.AbstractConfigSourceBuilder<T,Void>

io.helidon.config.MapConfigSource.MapBuilder<T>

Type Parameters:

T - type of the implementing builder

All Implemented Interfaces:

Builder<MapConfigSource.Builder, MapConfigSource>, PollableSource.Builder<T>, Source.Builder<T>, Supplier<MapConfigSource>

Direct Known Subclasses:

ConfigSources.SystemPropertiesConfigSource.Builder, MapConfigSource.Builder

Enclosing class:

MapConfigSource

public abstract static class MapConfigSource.MapBuilder<T extends MapConfigSource.MapBuilder<T>>
extends AbstractConfigSourceBuilder<T,Void>
implements Builder<MapConfigSource.Builder, MapConfigSource>, PollableSource.Builder<T>

An abstract fluent API builder for MapConfigSource. If you want to extend MapConfigSource, you can use this class as a base for your own builder.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MapBuilder()	Creat a new builder instance.

Method Summary

Modifier and Type	Method	Description
protected Map<?,?>	map()	Map used as data of this config source.
T	map(Map<String,String> map)	Map to be used as config source underlying data.
T	name(String sourceName)	Name of this source.
T	pollingStrategy(PollingStrategy pollingStrategy)	Configure a polling strategy.
T	properties(Properties properties)	Properties to be used as config source underlying data.
protected String	sourceName()	Name of the source.

Methods inherited from class AbstractConfigSourceBuilder

config, mediaType, mediaTypeMapping, parser, parserMapping

Modifier and Type	Method	Description
protected T	config(Config metaConfig)	Configure builder from meta configuration.
protected T	mediaType(MediaType mediaType)	Media type if this is a ParsableSource and explicit media type is configured.
T	mediaTypeMapping(Function<Config.Key, Optional<MediaType>> mediaTypeMapping)	Sets a function that maps keys to media type.
protected T	parser(ConfigParser parser)	A parser if this is a ParsableSource and explicit parser is configured.
T	parserMapping(Function<Config.Key, Optional<ConfigParser>> parserMapping)	Sets a function that maps keys to a parser.

Methods inherited from class AbstractSourceBuilder

changeWatcher, optional, retryPolicy

Modifier and Type	Method	Description
protected T	changeWatcher(ChangeWatcher<Void> changeWatcher)	Configure a change watcher.
T	optional(boolean optional)	Whether the source is optional or not.
T	retryPolicy(Supplier<? extends RetryPolicy> policy)	Configure a retry policy to be used with this source.

Methods inherited from class Object

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

Methods inherited from interface Builder

build, get, identity, update

Modifier and Type	Method	Description
MapConfigSource	build()	Build the instance from this builder.
default MapConfigSource	get()
default MapConfigSource.Builder	identity()	Instance of this builder as the correct type.
default MapConfigSource.Builder	update(Consumer<MapConfigSource.Builder> consumer)	Update the builder in a fluent API way.

Methods inherited from interface PollableSource.Builder

pollingStrategy

Modifier and Type	Method	Description
default T	pollingStrategy(Supplier<? extends PollingStrategy> pollingStrategy)	Configure the polling strategy to use.

Methods inherited from interface Source.Builder

optional

Modifier and Type	Method	Description
default T	optional()	Configure this source to be optional.

Constructor Details

MapBuilder

protected MapBuilder()

Creat a new builder instance.

Method Details

map

public T map(Map<String,String> map)

Map to be used as config source underlying data. The same instance is kept by the config source, to support polling.

Parameters:

map - map to use

Returns:

updated builder instance

properties

public T properties(Properties properties)

Properties to be used as config source underlying data. The same instance is kept by the config source, to support polling.

Parameters:

properties - properties to use

Returns:

updated builder instance

name

public T name(String sourceName)

Name of this source.

Parameters:

sourceName - name of this source

Returns:

updated builder instance

pollingStrategy

public T pollingStrategy(PollingStrategy pollingStrategy)

Description copied from class: AbstractSourceBuilder

Configure a polling strategy. This method must be exposed by builders of sources that support polling. If you see this method as being protected in your builder, the source has removed support for polling, such as ClasspathConfigSource.

Specified by:

pollingStrategy in interface PollableSource.Builder<T extends MapConfigSource.MapBuilder<T>>

Overrides:

pollingStrategy in class AbstractSourceBuilder<T extends MapConfigSource.MapBuilder<T>, Void>

Parameters:

pollingStrategy - polling strategy to use

Returns:

updated builder instance

map

protected Map<?,?> map()

Map used as data of this config source.

Returns:

map with the data

sourceName

protected String sourceName()

Name of the source.

Returns:

name