public final class Settings extends Object
GraphDatabaseSettings
for example.
Each setting has a name, a parser that converts a string to the type of the setting, a default value,
an optional inherited setting, and optional value converters.
A parser is a function that takes a string and converts to some type T. The parser may throw IllegalArgumentException
if it fails.
The default value is the string representation of what you want as default. Special values are the constants NO_DEFAULT,
which means that you don't want any default value at all, and MANDATORY, which means that the user has to specify a value
for this setting. Not providing a mandatory value for a setting leads to an IllegalArgumentException.
If a setting does not have a provided value, and no default, thenModifier and Type | Class and Description |
---|---|
static class |
Settings.DefaultSetting<T> |
Modifier and Type | Method and Description |
---|---|
static Function2<File,Function<String,String>,File> |
basePath(Setting<File> baseSetting) |
static <T> Function2<T,Function<String,String>,T> |
illegalValueMessage(String message,
Function2<T,Function<String,String>,T> valueFunction) |
static <T> Function<String,List<T>> |
list(String separator,
Function<String,T> itemParser) |
static Function2<String,Function<String,String>,String> |
matches(String regex) |
static <T extends Comparable<T>> |
max(T max) |
static <T extends Comparable<T>> |
min(T min) |
static <T extends Enum> |
options(Class<T> enumClass) |
static <T> Function<String,T> |
options(Iterable<T> optionValues) |
static <T> Function<String,T> |
options(T... optionValues) |
static boolean |
osIsMacOS() |
static boolean |
osIsWindows() |
static <T extends Comparable<T>> |
range(T min,
T max) |
static <T> Setting<T> |
setting(String name,
Function<String,T> parser,
Setting<T> inheritedSetting) |
static <T> Setting<T> |
setting(String name,
Function<String,T> parser,
String defaultValue) |
static <T> Setting<T> |
setting(String name,
Function<String,T> parser,
String defaultValue,
Function2<T,Function<String,String>,T>... valueConverters) |
static <T> Setting<T> |
setting(String name,
Function<String,T> parser,
String defaultValue,
Setting<T> inheritedSetting,
Function2<T,Function<String,String>,T>... valueConverters) |
public static final String MANDATORY
public static final String NO_DEFAULT
public static final String TRUE
public static final String FALSE
public static final String DURATION_FORMAT
public static final String SIZE_FORMAT
public static final String ANY
public static final Function<String,HostnamePort> HOSTNAME_PORT
public static final Function<String,Long> LONG_WITH_OPTIONAL_UNIT
public static <T> Setting<T> setting(String name, Function<String,T> parser, String defaultValue)
public static <T> Setting<T> setting(String name, Function<String,T> parser, String defaultValue, Function2<T,Function<String,String>,T>... valueConverters)
public static <T> Setting<T> setting(String name, Function<String,T> parser, Setting<T> inheritedSetting)
public static <T> Setting<T> setting(String name, Function<String,T> parser, String defaultValue, Setting<T> inheritedSetting, Function2<T,Function<String,String>,T>... valueConverters)
public static <T> Function<String,List<T>> list(String separator, Function<String,T> itemParser)
public static <T extends Comparable<T>> Function2<T,Function<String,String>,T> min(T min)
public static <T extends Comparable<T>> Function2<T,Function<String,String>,T> max(T max)
public static <T extends Comparable<T>> Function2<T,Function<String,String>,T> range(T min, T max)
public static <T> Function2<T,Function<String,String>,T> illegalValueMessage(String message, Function2<T,Function<String,String>,T> valueFunction)
public static Function2<File,Function<String,String>,File> basePath(Setting<File> baseSetting)
public static boolean osIsWindows()
public static boolean osIsMacOS()
Copyright © 2002–2014 The Neo4j Graph Database Project. All rights reserved.