org.neo4j.graphdb.config

Interface Setting<T>

Type Parameters:

T - type of value this setting will parse input string into and return.

All Superinterfaces:

Function<Function<String,String>,T>, SettingGroup<T>, SettingValidator

All Known Implementing Classes:

BaseSetting, ScopeAwareSetting

public interface Setting<T>
extends Function<Function<String,String>,T>, SettingValidator, SettingGroup<T>

Settings that can be provided in configurations are represented by instances of this interface, and are available as static fields in various *Settings classes. This interface is available only for use, not for implementing. Implementing this interface is not expected, and backwards compatibility is not guaranteed for implementors.

Method Summary

Modifier and Type	Method and Description
T	from(Configuration config)
String	getDefaultValue() Get the default value of this setting, as a string.
default Optional<Function<String,T>>	getParser() Get the function used to parse this setting.
String	name() Get the name of the setting.
default List<Setting<T>>	settings(Map<String,String> params)
default Map<String,String>	validate(Map<String,String> rawConfig, Consumer<String> warningConsumer) Validate one or several setting values, throwing on invalid values.
default Map<String,T>	values(Map<String,String> validConfig) Apply this setting group to the config and return all of its configured keys and their corresponding values.
void	withScope(Function<String,String> scopingRule) Make this setting bound to a scope

Methods inherited from interface java.util.function.Function

andThen, apply, compose, identity

Methods inherited from interface org.neo4j.graphdb.config.SettingGroup

deprecated, description, documentedDefaultValue, internal, replacement, valueDescription

Method Detail

name

String name()

Get the name of the setting. This typically corresponds to a key in a properties file, or similar.

Returns:

the name

withScope

void withScope(Function<String,String> scopingRule)

Make this setting bound to a scope

Parameters:

scopingRule - The scoping rule to be applied to this setting

getDefaultValue

String getDefaultValue()

Get the default value of this setting, as a string.

Returns:

the default value

from

T from(Configuration config)

values

default Map<String,T> values(Map<String,String> validConfig)

Description copied from interface: SettingGroup

Apply this setting group to the config and return all of its configured keys and their corresponding values.

Specified by:

values in interface SettingGroup<T>

Parameters:

validConfig - which can be examined

Returns:

the map of this group's configured keys and values

validate

default Map<String,String> validate(Map<String,String> rawConfig,
                                    Consumer<String> warningConsumer)
                             throws InvalidSettingException

Description copied from interface: SettingValidator

Validate one or several setting values, throwing on invalid values.

Specified by:

validate in interface SettingValidator

Parameters:

rawConfig - available to be validated

warningConsumer - a consumer for configuration warnings

Returns:

the set of settings considered valid by this validator

Throws:

InvalidSettingException - if invalid value detected

settings

default List<Setting<T>> settings(Map<String,String> params)

Specified by:

settings in interface SettingGroup<T>

Returns:

a list of the settings this group contains

getParser

default Optional<Function<String,T>> getParser()

Get the function used to parse this setting.

Returns:

the parser function