Module io.helidon.config

Package io.helidon.config

Class FileOverrideSource.Builder

java.lang.Object

io.helidon.config.AbstractSourceBuilder<FileOverrideSource.Builder,Path>

io.helidon.config.FileOverrideSource.Builder

All Implemented Interfaces:

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

Enclosing class:

FileOverrideSource

public static final class FileOverrideSource.Builder
extends AbstractSourceBuilder<FileOverrideSource.Builder,Path>
implements PollableSource.Builder<FileOverrideSource.Builder>, WatchableSource.Builder<FileOverrideSource.Builder,Path>, Builder<FileOverrideSource>

File OverrideSource Builder.

It allows to configure following properties:

• path - configuration file path;
• mandatory - is existence of configuration resource mandatory (by default) or is optional?

Method Summary

Modifier and Type	Method	Description
FileOverrideSource	build()	Builds new instance of File ConfigSource.
FileOverrideSource.Builder	changeWatcher(ChangeWatcher<Path> changeWatcher)	Configure a change watcher.
FileOverrideSource.Builder	config(Config metaConfig)	Configure builder from meta configuration.
FileOverrideSource.Builder	path(Path path)	Configure path to look for the source.
FileOverrideSource.Builder	pollingStrategy(PollingStrategy pollingStrategy)	Configure a polling strategy.

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

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

pollingStrategy

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

optional

Method Detail

build

public FileOverrideSource build()

Builds new instance of File ConfigSource.

If media-type not set it tries to guess it from file extension.

Specified by:

build in interface Builder<FileOverrideSource>

Returns:

new instance of File ConfigSource.

config

public FileOverrideSource.Builder config(Config metaConfig)

Description copied from class: AbstractSourceBuilder

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.

Overrides:

config in class AbstractSourceBuilder<FileOverrideSource.Builder,Path>

Parameters:

metaConfig - meta configuration of this source

Returns:

updated builder instance

path

public FileOverrideSource.Builder path(Path path)

Configure path to look for the source.

Parameters:

path - file path

Returns:

updated builder

changeWatcher

public FileOverrideSource.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<FileOverrideSource.Builder,Path>

Overrides:

changeWatcher in class AbstractSourceBuilder<FileOverrideSource.Builder,Path>

Parameters:

changeWatcher - change watcher to use, such as FileSystemWatcher

Returns:

updated builder instance

pollingStrategy

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

Overrides:

pollingStrategy in class AbstractSourceBuilder<FileOverrideSource.Builder,Path>

Parameters:

pollingStrategy - polling strategy to use

Returns:

updated builder instance