Skip to content

Commit 3664895

Browse files
snicollsnicoll
committed
Polish
1 parent fd0b1c6 commit 3664895

File tree

6 files changed

+42
-42
lines changed

6 files changed

+42
-42
lines changed

‎spring-boot-docs/src/main/asciidoc/appendix-configuration-metadata.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -217,8 +217,8 @@ The JSON object contained in the `hints` array can contain the following attribu
217217
the value and may have a description
218218

219219
|`providers`
220-
| ProviderHint[]
221-
| A list of providers as defined by the `ValueHint` object (see below). Each entry defines
220+
| ValueProvider[]
221+
| A list of providers as defined by the `ValueProvider` object (see below). Each entry defines
222222
the name of the provider and its parameters, if any.
223223

224224
|===
@@ -283,7 +283,7 @@ property, you can provide additional meta-data that:
283283
can discover the list of potential values based on the project's context.
284284

285285

286-
==== Value hints
286+
==== Value hint
287287
The `name` attribute of each hint refers to the `name` of a property. In the initial
288288
example above, we provide 3 values for the `server.tomcat.compression` property: `on`,
289289
`off` and `force`.
@@ -330,7 +330,7 @@ the most effective approach to auto-completion if your IDE supports it.
330330

331331

332332

333-
==== Provider hints
333+
==== Value provider
334334
Providers are a powerful way of attaching semantics to a property. We define in the section
335335
below the official providers that you can use for your own hints. Bare in mind however that
336336
your favorite IDE may implement some of these or none of them. It could eventually provide
@@ -345,7 +345,7 @@ The table below summarizes the list of supported providers:
345345
|Name | Description
346346

347347
|`any`
348-
|Permit any additional values to be provided.
348+
|Permit any additional value to be provided.
349349

350350
|`class-reference`
351351
|Auto-complete the classes available in the project. Usually constrained by a base
@@ -363,7 +363,7 @@ The table below summarizes the list of supported providers:
363363
by a base class that is specified via the `target` parameter.
364364

365365
|`spring-profile-name`
366-
|Auto-complete the available profile names in the project.
366+
|Auto-complete the available Spring profile names in the project.
367367

368368
|===
369369

‎spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/metadata/ItemHint.java

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -40,14 +40,14 @@ public class ItemHint implements Comparable<ItemHint> {
4040

4141
private final List<ValueHint> values;
4242

43-
private final List<ProviderHint> providers;
43+
private final List<ValueProvider> providers;
4444

45-
public ItemHint(String name, List<ValueHint> values, List<ProviderHint> providers) {
45+
public ItemHint(String name, List<ValueHint> values, List<ValueProvider> providers) {
4646
this.name = toCanonicalName(name);
4747
this.values = (values != null ? new ArrayList<ValueHint>(values)
4848
: new ArrayList<ValueHint>());
49-
this.providers = (providers != null ? new ArrayList<ProviderHint>(providers)
50-
: new ArrayList<ProviderHint>());
49+
this.providers = (providers != null ? new ArrayList<ValueProvider>(providers)
50+
: new ArrayList<ValueProvider>());
5151
}
5252

5353
private String toCanonicalName(String name) {
@@ -68,7 +68,7 @@ public List<ValueHint> getValues() {
6868
return Collections.unmodifiableList(this.values);
6969
}
7070

71-
public List<ProviderHint> getProviders() {
71+
public List<ValueProvider> getProviders() {
7272
return Collections.unmodifiableList(this.providers);
7373
}
7474

@@ -79,7 +79,7 @@ public int compareTo(ItemHint other) {
7979

8080
public static ItemHint newHint(String name, ValueHint... values) {
8181
return new ItemHint(name, Arrays.asList(values),
82-
Collections.<ProviderHint> emptyList());
82+
Collections.<ValueProvider> emptyList());
8383
}
8484

8585
@Override
@@ -115,13 +115,13 @@ public String toString() {
115115

116116
}
117117

118-
public static class ProviderHint {
118+
public static class ValueProvider {
119119

120120
private final String name;
121121

122122
private final Map<String, Object> parameters;
123123

124-
public ProviderHint(String name, Map<String, Object> parameters) {
124+
public ValueProvider(String name, Map<String, Object> parameters) {
125125
this.name = name;
126126
this.parameters = parameters;
127127
}

‎spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/metadata/JsonMarshaller.java

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -107,20 +107,20 @@ private JSONObject toJsonObject(ItemHint hint) {
107107
}
108108
if (!hint.getProviders().isEmpty()) {
109109
JSONArray providersArray = new JSONArray();
110-
for (ItemHint.ProviderHint providerHint : hint.getProviders()) {
111-
JSONObject providerHintObject = new JSONOrderedObject();
112-
providerHintObject.put("name", providerHint.getName());
113-
if (providerHint.getParameters() != null
114-
&& !providerHint.getParameters().isEmpty()) {
110+
for (ItemHint.ValueProvider valueProvider : hint.getProviders()) {
111+
JSONObject valueProviderObject = new JSONOrderedObject();
112+
valueProviderObject.put("name", valueProvider.getName());
113+
if (valueProvider.getParameters() != null
114+
&& !valueProvider.getParameters().isEmpty()) {
115115
JSONObject parametersObject = new JSONOrderedObject();
116-
for (Map.Entry<String, Object> entry : providerHint.getParameters()
116+
for (Map.Entry<String, Object> entry : valueProvider.getParameters()
117117
.entrySet()) {
118118
parametersObject.put(entry.getKey(),
119119
extractItemValue(entry.getValue()));
120120
}
121-
providerHintObject.put("parameters", parametersObject);
121+
valueProviderObject.put("parameters", parametersObject);
122122
}
123-
providersArray.put(providerHintObject);
123+
providersArray.put(valueProviderObject);
124124
}
125125
jsonObject.put("providers", providersArray);
126126
}
@@ -203,11 +203,11 @@ private ItemHint toItemHint(JSONObject object) {
203203
values.add(toValueHint((JSONObject) valuesArray.get(i)));
204204
}
205205
}
206-
List<ItemHint.ProviderHint> providers = new ArrayList<ItemHint.ProviderHint>();
206+
List<ItemHint.ValueProvider> providers = new ArrayList<ItemHint.ValueProvider>();
207207
if (object.has("providers")) {
208208
JSONArray providersObject = object.getJSONArray("providers");
209209
for (int i = 0; i < providersObject.length(); i++) {
210-
providers.add(toProviderHint((JSONObject) providersObject.get(i)));
210+
providers.add(toValueProvider((JSONObject) providersObject.get(i)));
211211
}
212212
}
213213
return new ItemHint(name, values, providers);
@@ -219,7 +219,7 @@ private ItemHint.ValueHint toValueHint(JSONObject object) {
219219
return new ItemHint.ValueHint(value, description);
220220
}
221221

222-
private ItemHint.ProviderHint toProviderHint(JSONObject object) {
222+
private ItemHint.ValueProvider toValueProvider(JSONObject object) {
223223
String name = object.getString("name");
224224
Map<String, Object> parameters = new HashMap<String, Object>();
225225
if (object.has("parameters")) {
@@ -230,7 +230,7 @@ private ItemHint.ProviderHint toProviderHint(JSONObject object) {
230230
parameters.put(key, value);
231231
}
232232
}
233-
return new ItemHint.ProviderHint(name, parameters);
233+
return new ItemHint.ValueProvider(name, parameters);
234234
}
235235

236236
private Object readItemValue(Object value) {

‎spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationprocessor/ConfigurationMetadataAnnotationProcessorTests.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -384,9 +384,9 @@ public void mergingOfHintWithNonCanonicalName() throws Exception {
384384
public void mergingOfHintWithProvider() throws Exception {
385385
writeAdditionalHints(new ItemHint("simple.theName",
386386
Collections.<ItemHint.ValueHint> emptyList(), Arrays.asList(
387-
new ItemHint.ProviderHint("first", Collections
387+
new ItemHint.ValueProvider("first", Collections
388388
.<String, Object> singletonMap("target", "org.foo")),
389-
new ItemHint.ProviderHint("second", null))));
389+
new ItemHint.ValueProvider("second", null))));
390390
ConfigurationMetadata metadata = compile(SimpleProperties.class);
391391
assertThat(metadata,
392392
containsHint("simple.the-name")

‎spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationprocessor/ConfigurationMetadataMatchers.java

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -209,15 +209,15 @@ public static class ContainsHintMatcher extends BaseMatcher<ConfigurationMetadat
209209

210210
private final List<ValueHintMatcher> values;
211211

212-
private final List<ProviderHintMatcher> providers;
212+
private final List<ValueProviderMatcher> providers;
213213

214214
public ContainsHintMatcher(String name) {
215215
this(name, new ArrayList<ValueHintMatcher>(),
216-
new ArrayList<ProviderHintMatcher>());
216+
new ArrayList<ValueProviderMatcher>());
217217
}
218218

219219
public ContainsHintMatcher(String name, List<ValueHintMatcher> values,
220-
List<ProviderHintMatcher> providers) {
220+
List<ValueProviderMatcher> providers) {
221221
this.name = name;
222222
this.values = values;
223223
this.providers = providers;
@@ -238,7 +238,7 @@ public boolean matches(Object item) {
238238
return false;
239239
}
240240
}
241-
for (ProviderHintMatcher provider : this.providers) {
241+
for (ValueProviderMatcher provider : this.providers) {
242242
if (!provider.matches(itemHint)) {
243243
return false;
244244
}
@@ -277,9 +277,9 @@ public ContainsHintMatcher withValue(int index, Object value, String description
277277

278278
public ContainsHintMatcher withProvider(int index, String provider,
279279
Map<String, Object> parameters) {
280-
List<ProviderHintMatcher> providers = new ArrayList<ProviderHintMatcher>(
280+
List<ValueProviderMatcher> providers = new ArrayList<ValueProviderMatcher>(
281281
this.providers);
282-
providers.add(new ProviderHintMatcher(index, provider, parameters));
282+
providers.add(new ValueProviderMatcher(index, provider, parameters));
283283
return new ContainsHintMatcher(this.name, this.values, providers);
284284
}
285285

@@ -347,12 +347,12 @@ public void describeTo(Description description) {
347347

348348
}
349349

350-
public static class ProviderHintMatcher extends BaseMatcher<ItemHint> {
350+
public static class ValueProviderMatcher extends BaseMatcher<ItemHint> {
351351
private final int index;
352352
private final String name;
353353
private final Map<String, Object> parameters;
354354

355-
public ProviderHintMatcher(int index, String name, Map<String, Object> parameters) {
355+
public ValueProviderMatcher(int index, String name, Map<String, Object> parameters) {
356356
this.index = index;
357357
this.name = name;
358358
this.parameters = parameters;
@@ -364,14 +364,14 @@ public boolean matches(Object item) {
364364
if (this.index + 1 > hint.getProviders().size()) {
365365
return false;
366366
}
367-
ItemHint.ProviderHint providerHint = hint.getProviders().get(this.index);
368-
if (this.name != null && !this.name.equals(providerHint.getName())) {
367+
ItemHint.ValueProvider valueProvider = hint.getProviders().get(this.index);
368+
if (this.name != null && !this.name.equals(valueProvider.getName())) {
369369
return false;
370370
}
371371
if (this.parameters != null) {
372372
for (Map.Entry<String, Object> entry : this.parameters.entrySet()) {
373373
if (!IsMapContaining.hasEntry(entry.getKey(), entry.getValue())
374-
.matches(providerHint.getParameters())) {
374+
.matches(valueProvider.getParameters())) {
375375
return false;
376376
}
377377
}
@@ -381,7 +381,7 @@ public boolean matches(Object item) {
381381

382382
@Override
383383
public void describeTo(Description description) {
384-
description.appendText("provider hint ");
384+
description.appendText("value provider ");
385385
if (this.name != null) {
386386
description.appendText(" name ").appendValue(this.name);
387387
}

‎spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationprocessor/metadata/JsonMarshallerTests.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,9 @@ public void marshallAndUnmarshal() throws IOException {
5858
metadata.add(ItemHint.newHint("a.b"));
5959
metadata.add(ItemHint.newHint("c", new ItemHint.ValueHint(123, "hey"),
6060
new ItemHint.ValueHint(456, null)));
61-
metadata.add(new ItemHint("d", null, Arrays.asList(new ItemHint.ProviderHint(
61+
metadata.add(new ItemHint("d", null, Arrays.asList(new ItemHint.ValueProvider(
6262
"first", Collections.<String, Object> singletonMap("target", "foo")),
63-
new ItemHint.ProviderHint("second", null))));
63+
new ItemHint.ValueProvider("second", null))));
6464
ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
6565
JsonMarshaller marshaller = new JsonMarshaller();
6666
marshaller.write(metadata, outputStream);

0 commit comments

Comments
 (0)