Module io.helidon.config

Package io.helidon.config

Class DirectoryConfigSource.Builder

java.lang.Object

io.helidon.config.AbstractSourceBuilder<B,U>

io.helidon.config.AbstractConfigSourceBuilder<DirectoryConfigSource.Builder,Path>

io.helidon.config.DirectoryConfigSource.Builder

All Implemented Interfaces:

Builder<DirectoryConfigSource.Builder,DirectoryConfigSource>, PollableSource.Builder<DirectoryConfigSource.Builder>, Source.Builder<DirectoryConfigSource.Builder>, WatchableSource.Builder<DirectoryConfigSource.Builder,Path>, Supplier<DirectoryConfigSource>

Enclosing class:

DirectoryConfigSource

public static final class DirectoryConfigSource.Builder
extends AbstractConfigSourceBuilder<DirectoryConfigSource.Builder,Path>
implements PollableSource.Builder<DirectoryConfigSource.Builder>, WatchableSource.Builder<DirectoryConfigSource.Builder,Path>, Builder<DirectoryConfigSource.Builder,DirectoryConfigSource>

Common ancestor for config source builders, taking care of configurable options understood by the config module.

A fluent API builder for DirectoryConfigSource.

Method Summary

Modifier and Type	Method	Description
DirectoryConfigSource	build()	Builds new instance of Directory ConfigSource.
DirectoryConfigSource.Builder	changeWatcher(ChangeWatcher<Path> changeWatcher)	Configure a change watcher.
DirectoryConfigSource.Builder	config(Config metaConfig)	Configure builder from meta configuration.
DirectoryConfigSource.Builder	path(Path path)	Configuration directory path.
DirectoryConfigSource.Builder	pollingStrategy(PollingStrategy pollingStrategy)	Configure a polling strategy.

Methods inherited from class io.helidon.config.AbstractConfigSourceBuilder

mediaType, mediaTypeMapping, parser, parserMapping

Methods inherited from class io.helidon.config.AbstractSourceBuilder

optional, retryPolicy

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.common.Builder

get, identity, update

Methods inherited from interface io.helidon.config.spi.PollableSource.Builder

pollingStrategy

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

optional, optional, retryPolicy

Method Details

build

public DirectoryConfigSource build()

Builds new instance of Directory ConfigSource.

Specified by:

build in interface Builder<DirectoryConfigSource.Builder,DirectoryConfigSource>

Returns:

new instance of File ConfigSource.

config

public DirectoryConfigSource.Builder config(Config metaConfig)

Configure builder from meta configuration.

The following configuration options are supported:

Optional configuration parameters

key	default value	description
optional	false	Configure to true if this source should not fail configuration setup when underlying data is missing.
polling-strategy	No polling strategy is added by default	Meta configuration of a polling strategy to be used with this source, add configuration to properties sub node.
change-watcher	No change watcher is added by default	Meta configuration of a change watcher to be used with this source, add configuration to properties sub node.
retry-policy	No retry policy is added by default	Meta configuration of a retry policy to be used to load this source, add configuration to properties sub node.

Media type and type mapping

media-type	Media type from loaded data is used by default for parsable config sources	Explicit media type to use, such as when a file has invalid suffix, or when we need to explicitly mark the media type.
media-type-mapping	No media type mapping is done by default	A mapping of key to a media type, allowing us to have a key that contains a sub-tree (e.g. a key that contains json data) - when we configure a mapping of the key to application/json, the data would be expanded into config as a proper tree structure

• path - directory path

Overrides:

config in class AbstractConfigSourceBuilder<DirectoryConfigSource.Builder,Path>

Parameters:

metaConfig - configuration properties used to configure a builder instance.

Returns:

updated builder instance

path

public DirectoryConfigSource.Builder path(Path path)

Configuration directory path.

Parameters:

path - directory

Returns:

updated builder instance

changeWatcher

public DirectoryConfigSource.Builder changeWatcher(ChangeWatcher<Path> changeWatcher)

Description copied from class: AbstractSourceBuilder

Configure a change watcher. This method must be exposed by builders of sources that change watching (WatchableSource). The type of the change watcher must match the type of the target of this source.

Specified by:

changeWatcher in interface WatchableSource.Builder<DirectoryConfigSource.Builder,Path>

Overrides:

changeWatcher in class AbstractSourceBuilder<DirectoryConfigSource.Builder,Path>

Parameters:

changeWatcher - change watcher to use, such as FileSystemWatcher

Returns:

updated builder instance

pollingStrategy

public DirectoryConfigSource.Builder 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<DirectoryConfigSource.Builder>

Overrides:

pollingStrategy in class AbstractSourceBuilder<DirectoryConfigSource.Builder,Path>

Parameters:

pollingStrategy - polling strategy to use

Returns:

updated builder instance