Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Sign in / Register
Toggle navigation
S
spring-boot
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
DEMO
spring-boot
Commits
38d36ab1
Commit
38d36ab1
authored
Aug 13, 2019
by
Madhura Bhave
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Document how to add metadata for collection and enum default values
Closes gh-12874
parent
56c2a52e
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
45 additions
and
0 deletions
+45
-0
appendix-configuration-metadata.adoc
...cs/src/main/asciidoc/appendix-configuration-metadata.adoc
+45
-0
No files found.
spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix-configuration-metadata.adoc
View file @
38d36ab1
...
...
@@ -814,6 +814,51 @@ special handling for collection types (that is detected even if only a getter is
The
annotation
processor
also
supports
the
use
of
the
`@
Data
`,
`@
Getter
`,
and
`@
Setter
`
lombok
annotations
.
The
annotation
processor
cannot
auto
-
detect
default
values
for
``
Enum
``
s
and
``
Collections
``
s
.
In
the
cases
where
a
`
Collection
`
or
`
Enum
`
property
has
a
non
-
empty
default
value
,
<<
configuration
-
metadata
-
additional
-
metadata
,
manual
metadata
>>
should
be
provided
.
Consider
the
following
class
:
[
source
,
java
,
indent
=
0
,
subs
=
"verbatim,quotes,attributes"
]
----
@
ConfigurationProperties
(
prefix
=
"rabbit"
)
public
class
RabbitProperties
{
private
List
<
String
>
addresses
=
new
ArrayList
<>(
Arrays
.
asList
(
"a"
,
"b"
))
;
private
ContainerType
=
ContainerType
.
SIMPLE
;
//
...
getter
and
setters
public
enum
ContainerType
{
SIMPLE
,
DIRECT
}
}
----
In
order
to
document
default
values
for
properties
in
the
class
above
,
you
could
add
the
following
JSON
to
<<
configuration
-
metadata
-
additional
-
metadata
,
the
manual
metadata
of
the
module
>>:
[
source
,
json
,
indent
=
0
]
----
{
"name"
:
"rabbit.addresses"
,
"defaultValue"
:
"a, b"
},
{
"name"
:
"rabbit.container-type"
,
"defaultValue"
:
"simple"
}
----
[
NOTE
]
====
If
you
are
using
AspectJ
in
your
project
,
you
need
to
make
sure
that
the
annotation
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment