Module io.helidon.config

Package io.helidon.config

Class ConfigFilters.ValueResolvingBuilder

java.lang.Object

io.helidon.config.ConfigFilters.ValueResolvingBuilder

All Implemented Interfaces:

Supplier<Function<Config,ConfigFilter>>

Enclosing class:

ConfigFilters

public static final class ConfigFilters.ValueResolvingBuilder
extends Object
implements Supplier<Function<Config,ConfigFilter>>

A builder for value reference resolving filter.

The ValueResolvingFilter can either allow (the default) or reject references to missing tokens. To reject such references, invoke the failOnMissingReference method on the builder before invoking build().

Alternatively, if you create the builder using the create(io.helidon.config.Config) method, in the Config instance you pass set the config key "config.value-resolving-filter.fail-on-missing-reference" to true.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FAIL_ON_MISSING_REFERENCE_KEY_NAME	Config key for setting missing reference behavior on ValueResolvingFilters.

Method Summary

Modifier and Type	Method	Description
Function<Config,ConfigFilter>	build()	Creates a function of values reference resolving.
static ConfigFilters.ValueResolvingBuilder	create(Config metaConfig)	Initializes config filter instance from configuration properties.
ConfigFilters.ValueResolvingBuilder	failOnMissingReference(boolean failOnMissing)	Sets how the ValueResolvingFilter resulting from this builder will behave when a value contains a reference to a non-existent key.
Function<Config,ConfigFilter>	get()

Methods inherited from class java.lang.Object

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

Field Details

FAIL_ON_MISSING_REFERENCE_KEY_NAME

public static final String FAIL_ON_MISSING_REFERENCE_KEY_NAME

Config key for setting missing reference behavior on ValueResolvingFilters.

See Also:

• Constant Field Values

Method Details

create

public static ConfigFilters.ValueResolvingBuilder create(Config metaConfig)
                                                  throws ConfigMappingException,
MissingValueException

Initializes config filter instance from configuration properties.

Optional properties:

• failOnMissingReference - type Boolean, see failOnMissingReference

Parameters:

metaConfig - meta-configuration used to initialize returned config filter instance from

Returns:

new instance of config filter builder described by metaConfig

Throws:

MissingValueException - in case the configuration tree does not contain all expected sub-nodes required by the mapper implementation to provide instance of Java type.

ConfigMappingException - in case the mapper fails to map the (existing) configuration tree represented by the supplied configuration node to an instance of a given Java type.

See Also:

• ConfigFilters.valueResolving()

failOnMissingReference

public ConfigFilters.ValueResolvingBuilder failOnMissingReference(boolean failOnMissing)

Sets how the ValueResolvingFilter resulting from this builder will behave when a value contains a reference to a non-existent key.

Parameters:

failOnMissing - whether the filter should fail on missing references or not

Returns:

this builder

build

public Function<Config,ConfigFilter> build()

Creates a function of values reference resolving.

Returns:

a provider of config filter

get

public Function<Config,ConfigFilter> get()

Specified by:

get in interface Supplier<Function<Config,ConfigFilter>>