-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
LoadableConfig.java
120 lines (107 loc) · 4.48 KB
/
LoadableConfig.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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
/*
* 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.configuration;
import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.List;
import java.util.ServiceLoader;
import java.util.stream.Collectors;
import java.util.stream.StreamSupport;
import org.neo4j.graphdb.config.BaseSetting;
import org.neo4j.graphdb.config.SettingGroup;
/**
* Every class which contains settings should implement this interface to allow the configuration to find the
* settings via service loading.
*/
public interface LoadableConfig
{
/**
* Collects settings from implementors which may or may not have descriptions attached to them.
*
* @return a list of the implementing class's ConfigOptions
*/
default List<ConfigOptions> getConfigOptions()
{
ArrayList<ConfigOptions> configOptions = new ArrayList<>();
for ( Field f : getClass().getDeclaredFields() )
{
try
{
Object publicSetting = f.get( this );
if ( publicSetting instanceof BaseSetting )
{
BaseSetting setting = (BaseSetting) publicSetting;
final Description documentation = f.getAnnotation( Description.class );
if ( documentation != null )
{
setting.setDescription( documentation.value() );
}
final DocumentedDefaultValue defValue = f.getAnnotation( DocumentedDefaultValue.class );
if ( defValue != null )
{
setting.setDocumentedDefaultValue( defValue.value() );
}
final Deprecated deprecatedAnnotation = f.getAnnotation( Deprecated.class );
setting.setDeprecated( deprecatedAnnotation != null );
final ReplacedBy replacedByAnnotation = f.getAnnotation( ReplacedBy.class );
if ( replacedByAnnotation != null )
{
setting.setReplacement( replacedByAnnotation.value() );
}
final Internal internalAnnotation = f.getAnnotation( Internal.class );
setting.setInternal( internalAnnotation != null );
final Secret secretAnnotation = f.getAnnotation( Secret.class );
setting.makeSecret( secretAnnotation != null );
final Dynamic dynamicAnnotation = f.getAnnotation( Dynamic.class );
setting.setDynamic( dynamicAnnotation != null );
}
if ( publicSetting instanceof SettingGroup )
{
SettingGroup setting = (SettingGroup) publicSetting;
configOptions.add( new ConfigOptions( setting ) );
}
}
catch ( IllegalAccessException ignored )
{
// Field is private, ignore it
}
}
return configOptions;
}
/**
* @return instances of all classes with loadable configuration options
*/
static List<LoadableConfig> allConfigClasses()
{
return StreamSupport.stream( ServiceLoader.load( LoadableConfig.class ).spliterator(), false )
.collect( Collectors.toList() );
}
/**
* Collects and returns settings of all known implementors.
* @return all ConfigOptions known at runtime.
*/
static List<ConfigOptions> loadAllAvailableConfigOptions()
{
return StreamSupport.stream( ServiceLoader.load( LoadableConfig.class ).spliterator(), false )
.map( LoadableConfig::getConfigOptions )
.flatMap( List::stream )
.collect( Collectors.toList() );
}
}