-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
SettingGroup.java
90 lines (79 loc) · 2.73 KB
/
SettingGroup.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
/*
* Copyright (c) 2002-2018 "Neo Technology,"
* Network Engine for Objects in Lund AB [http://neotechnology.com]
*
* This file is part of Neo4j.
*
* Neo4j is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.neo4j.graphdb.config;
import java.util.List;
import java.util.Map;
import java.util.Optional;
/**
* 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.
*
* @deprecated The settings API will be completely rewritten in 4.0
*/
@Deprecated
public interface SettingGroup<T> extends SettingValidator
{
/**
* Apply this setting group to the config and return all of its configured keys and their corresponding values.
*
* @param validConfig which can be examined.
* @return the map of this group's configured keys and values.
*/
Map<String,T> values( Map<String,String> validConfig );
/**
* @return a list of the settings this group contains.
*/
List<Setting<T>> settings( Map<String,String> params );
/**
* @return {@code true} if this setting is deprecated, false otherwise.
*/
boolean deprecated();
/**
* @return the key of the setting which replaces this when its deprecated, empty if not deprecated.
*/
Optional<String> replacement();
/**
* @return {@code true} if internal setting, false otherwise.
*/
boolean internal();
/**
* @return {@code true} if secret setting (should be hidden), false otherwise.
*/
boolean isSecret();
/**
* @return the documented default value if it needs special documentation, empty if default value is good as is.
*/
Optional<String> documentedDefaultValue();
/**
* @return description of which values are good
*/
String valueDescription();
/**
* @return description of setting, empty in case no description exists.
*/
Optional<String> description();
/**
* @return {@code true} if the setting can be changed at runtime.
*/
default boolean dynamic()
{
return false;
}
}