org.neo4j.graphdb.config

Interface SettingGroup<T>

All Superinterfaces:

SettingValidator

All Known Subinterfaces:

Setting<T>

All Known Implementing Classes:

BaseSetting, ScopeAwareSetting

public interface SettingGroup<T>
extends SettingValidator

This interface represents a setting group. One example can be group defined by a common prefix, such as `dbms.connector.*`. The important aspect is that config keys can only be known after a config has been parsed.

Method Summary

Modifier and Type	Method and Description
boolean	deprecated()
Optional<String>	description()
Optional<String>	documentedDefaultValue()
boolean	internal()
Optional<String>	replacement()
List<Setting<T>>	settings(Map<String,String> params)
String	valueDescription()
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.

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

validate

Method Detail

values

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.

Parameters:

validConfig - which can be examined

Returns:

the map of this group's configured keys and values

settings

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

Returns:

a list of the settings this group contains

deprecated

boolean deprecated()

Returns:

true if this setting is deprecated, false otherwise

replacement

Optional<String> replacement()

Returns:

the key of the setting which replaces this when its deprecated, empty if not depricated

internal

boolean internal()

Returns:

true if internal setting, false otherwise

documentedDefaultValue

Optional<String> documentedDefaultValue()

Returns:

the documented default value if it needs special documentation, empty if default value is good as is

valueDescription

String valueDescription()

Returns:

description of which values are good

description

Optional<String> description()

Returns:

description of setting, empty in case no description exists