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>

All Known Implementing Classes:

ScopeAwareSetting

public interface Setting<T>
extends Function<Function<String,String>,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.
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

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)

getParser

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

Get the function used to parse this setting.

Returns:

the parser function