org.neo4j.graphdb.config

Class BaseSetting<T>

java.lang.Object

org.neo4j.graphdb.config.BaseSetting<T>

All Implemented Interfaces:

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

Direct Known Subclasses:

ScopeAwareSetting

public abstract class BaseSetting<T>
extends Object
implements Setting<T>

All fields specified here are set via annotations when loaded

Constructor Summary

Constructors

Constructor and Description
BaseSetting()

Method Summary

Modifier and Type	Method and Description
boolean	deprecated()
Optional<String>	description()
Optional<String>	documentedDefaultValue()
boolean	internal()
Optional<String>	replacement()
void	setDeprecated(boolean val)
void	setDescription(String description)
void	setDocumentedDefaultValue(String val)
void	setInternal(boolean val)
void	setReplacement(String val)
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

from, getDefaultValue, getParser, name, settings, validate, values, withScope

Methods inherited from interface java.util.function.Function

andThen, apply, compose, identity

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

valueDescription

Constructor Detail

BaseSetting

public BaseSetting()

Method Detail

deprecated

public boolean deprecated()

Specified by:

deprecated in interface SettingGroup<T>

Returns:

true if this setting is deprecated, false otherwise

setDeprecated

public void setDeprecated(boolean val)

replacement

public Optional<String> replacement()

Specified by:

replacement in interface SettingGroup<T>

Returns:

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

setReplacement

public void setReplacement(String val)

internal

public boolean internal()

Specified by:

internal in interface SettingGroup<T>

Returns:

true if internal setting, false otherwise

setInternal

public void setInternal(boolean val)

documentedDefaultValue

public Optional<String> documentedDefaultValue()

Specified by:

documentedDefaultValue in interface SettingGroup<T>

Returns:

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

setDocumentedDefaultValue

public void setDocumentedDefaultValue(String val)

description

public Optional<String> description()

Specified by:

description in interface SettingGroup<T>

Returns:

description of setting, empty in case no description exists

setDescription

public void setDescription(String description)

toString

public String toString()

Overrides:

toString in class Object