-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
SettingDescription.java
165 lines (146 loc) · 4.72 KB
/
SettingDescription.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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
/*
* Copyright (c) 2002-2016 "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.doc;
import java.util.Objects;
import java.util.function.Function;
/**
* Represents a configuration item to be included into the generated Asciidoc.
*/
public final class SettingDescription
{
private final String id;
private final String name;
private final String description;
private final String mandatoryDescription;
private final String deprecationDescription;
private final String validationDescription;
private final String defaultValue;
private final boolean isDeprecated;
private final boolean isMandatory;
private final boolean hasDefault;
public SettingDescription( String id, String name, String description, String mandatoryDescription, String
deprecationDescription,
String validationDescription, String defaultValue,
boolean isDeprecated, boolean isMandatory, boolean hasDefault )
{
this.id = id;
this.mandatoryDescription = mandatoryDescription;
this.deprecationDescription = deprecationDescription;
this.validationDescription = validationDescription;
this.defaultValue = defaultValue;
this.isDeprecated = isDeprecated;
this.name = name.replace( "{", "\\{" ).replace( "}", "\\}" );
this.description = description;
this.isMandatory = isMandatory;
this.hasDefault = hasDefault;
}
public SettingDescription( String id, String name, String description )
{
this( id, name, description, null, null, null, null, false, false, false );
}
public String id()
{
return id;
}
public String name()
{
return name;
}
public String description()
{
return description;
}
public boolean isDeprecated()
{
return isDeprecated;
}
public boolean hasDefault()
{
//if ( !defaultValue.equals( DEFAULT_MARKER ) )
return hasDefault;
}
public String defaultValue()
{
return defaultValue;
}
public boolean isMandatory()
{
return isMandatory;
}
public String mandatoryDescription()
{
// Note MANDATORY
return mandatoryDescription;
}
public String deprecationMessage()
{
// Note OBSOLETED & DEPRECATED
return deprecationDescription;
}
public String validationMessage()
{
// Note VALIDATION_MESSAGE
return validationDescription;
}
/**
* Return a new item with all prose descriptions formatted using
* the passed-in format.
*/
public SettingDescription formatted( Function<String, String> format )
{
Function<String,String> f = ( str ) -> str == null ? null : format.apply(str);
return new SettingDescription(
id, name,
f.apply( description ),
f.apply(mandatoryDescription),
f.apply(deprecationDescription),
// I don't like this, but validationdescription contains a lot of
// technical terms, and the formatters barf on it. Leave it out for now,
// which is what the old impl did, and improve the formatters at some point
validationDescription,
defaultValue,
isDeprecated, isMandatory, hasDefault );
}
@Override
public boolean equals( Object o )
{
if ( this == o )
{
return true;
}
if ( o == null || getClass() != o.getClass() )
{
return false;
}
SettingDescription that = (SettingDescription) o;
return Objects.equals( name, that.name ) &&
Objects.equals( description, that.description );
}
@Override
public int hashCode()
{
return Objects.hash( name, description );
}
@Override
public String toString()
{
return "SettingDescription{" + "id='" + id() + "\', name='" + name + "\', description='" + description + "\'}";
}
}