Package io.helidon.config.spi

Class AbstractParsableConfigSource.Builder<B extends AbstractParsableConfigSource.Builder<B,T>,T>

java.lang.Object

io.helidon.config.spi.AbstractSource.Builder<B,T,ConfigSource>

io.helidon.config.spi.AbstractConfigSource.Builder<B,T>

io.helidon.config.spi.AbstractParsableConfigSource.Builder<B,T>

Type Parameters:

B - type of Builder implementation

T - type of key source attributes (target) used to construct polling strategy from

Direct Known Subclasses:

EtcdConfigSourceBuilder, GitConfigSourceBuilder

Enclosing class:

AbstractParsableConfigSource<S>

public abstract static class AbstractParsableConfigSource.Builder<B extends AbstractParsableConfigSource.Builder<B,T>,T>
extends AbstractConfigSource.Builder<B,T>

Common AbstractParsableConfigSource Builder, suitable for concrete implementations of Builder that are related to ConfigSources which extend AbstractParsableConfigSource

The application can control the following behavior:

• mandatory - whether the configuration source must exist (default: true)
• media-type - configuration content media type to be used to look for appropriate ConfigParser;
• parser - the ConfigParser to be used to parse the source
• changes executor and subscriber's buffer size - behavior related to AbstractConfigSource.changes() support

If the ConfigSource is mandatory and a source does not exist then Source.load() throws a ConfigException.

If the application does not explicit set media-type the Builder tries to infer it from the source, for example from the source URI.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder(java.lang.Class<T> targetType)	Initialize builder.

Method Summary

Modifier and Type	Method	Description
protected java.lang.String	getMediaType()	Returns media type property.
protected ConfigParser	getParser()	Returns parser property.
protected B	init(Config metaConfig)	Initialize builder from specified configuration properties.
B	mediaType(java.lang.String mediaType)	Sets configuration content media type.
B	parser(ConfigParser parser)	Sets a ConfigParser instance to be used to parse configuration content.

Methods inherited from class io.helidon.config.spi.AbstractConfigSource.Builder

get, getMediaTypeMapping, getParserMapping, mediaTypeMapping, parserMapping

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

build, changesExecutor, changesMaxBuffer, getChangesExecutor, getChangesMaxBuffer, getPollingStrategy, getRetryPolicy, getTarget, isMandatory, optional, pollingStrategy, pollingStrategy, retryPolicy

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

protected Builder(java.lang.Class<T> targetType)

Initialize builder.

Parameters:

targetType - target type

Method Detail

init

protected B init(Config metaConfig)

Initialize builder from specified configuration properties.

Supported configuration properties:

• optional - type boolean, see AbstractSource.Builder.optional()
• polling-strategy - see PollingStrategy for details about configuration format, see AbstractSource.Builder.pollingStrategy(Supplier) or AbstractSource.Builder.pollingStrategy(Function)

• media-type-mapping - type Map - key to media type, see AbstractConfigSource.Builder.mediaTypeMapping(Function)

• media-type - type String, see mediaType(String)

Overrides:

init in class AbstractConfigSource.Builder<B extends AbstractParsableConfigSource.Builder<B,T>,T>

Parameters:

metaConfig - configuration properties used to initialize a builder instance.

Returns:

modified builder instance

mediaType

public B mediaType(java.lang.String mediaType)

Sets configuration content media type.

Parameters:

mediaType - a configuration content media type

Returns:

modified builder instance

parser

public B parser(ConfigParser parser)

Sets a ConfigParser instance to be used to parse configuration content.

If the parser is set, the media type property is ignored.

Parameters:

parser - parsed used to parse configuration content

Returns:

modified builder instance

getMediaType

protected java.lang.String getMediaType()

Returns media type property.

Returns:

media type property.

getParser

protected ConfigParser getParser()

Returns parser property.

Returns:

parser property.