Commit 704992e6 authored by Stephane Nicoll's avatar Stephane Nicoll

Merge branch '2.1.x'

Closes gh-17855
parents ccf9b1b9 fcf46806
...@@ -821,20 +821,21 @@ The annotation processor also supports the use of the `@Data`, `@Getter`, and `@ ...@@ -821,20 +821,21 @@ The annotation processor also supports the use of the `@Data`, `@Getter`, and `@
lombok annotations. lombok annotations.
The annotation processor cannot auto-detect default values for ``Enum``s and ``Collections``s. The annotation processor cannot auto-detect default values for ``Enum``s and
In the cases where a `Collection` or `Enum` property has a non-empty default value, ``Collections``s. In the cases where a `Collection` or `Enum` property has a non-empty
<<configuration-metadata-additional-metadata,manual metadata>> should be provided. default value, <<configuration-metadata-additional-metadata,manual metadata>> should be
provided.
Consider the following class: Consider the following class:
[source,java,indent=0,subs="verbatim,quotes,attributes"] [source,java,indent=0,subs="verbatim,quotes,attributes"]
---- ----
@ConfigurationProperties(prefix="rabbit") @ConfigurationProperties(prefix="acme.messaging")
public class RabbitProperties { public class MessagingProperties {
private List<String> addresses = new ArrayList<>(Arrays.asList("a", "b")) ; private List<String> addresses = new ArrayList<>(Arrays.asList("a", "b")) ;
private ContainerType = ContainerType.SIMPLE; private ContainerType = ContainerType.SIMPLE;
// ... getter and setters // ... getter and setters
...@@ -849,21 +850,27 @@ Consider the following class: ...@@ -849,21 +850,27 @@ Consider the following class:
} }
---- ----
In order to document default values for properties in the class above, you could add the following In order to document default values for properties in the class above, you could add the
JSON to <<configuration-metadata-additional-metadata,the manual metadata of the module>>: following content to <<configuration-metadata-additional-metadata,the manual metadata of
the module>>:
[source,json,indent=0] [source,json,indent=0]
---- ----
{ {"properties": [
"name": "rabbit.addresses", {
"defaultValue": "a, b" "name": "acme.messaging.addresses",
}, "defaultValue": ["a, b"]
{ },
"name": "rabbit.container-type", {
"defaultValue": "simple" "name": "acme.messaging.container-type",
} "defaultValue": "simple"
}
]}
---- ----
Only the `name` of the property is required to document additional fields with manual
metadata.
[NOTE] [NOTE]
==== ====
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment