Skip to content

Commit afa2af1

Browse files
committed
Correct docs on when setter is not needed with JavaBean binding
The two main changes are: - A setter is no longer required when binding from a comma-separated list as long as the target list is mutable. The binder clears the list and then re-populates it. - A setter is now required for arrays, previously the values coming from configuration properties where merged into an existing array. Now, the array is replaced. Closes gh-43138
1 parent 53bda71 commit afa2af1

File tree

1 file changed

+2
-6
lines changed
  • spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/features

1 file changed

+2
-6
lines changed

spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/features/external-config.adoc

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -767,12 +767,8 @@ NOTE: The properties that map to javadoc:org.springframework.boot.context.proper
767767
Such arrangement relies on a default empty constructor and getters and setters are usually mandatory, since binding is through standard Java Beans property descriptors, just like in Spring MVC.
768768
A setter may be omitted in the following cases:
769769
770-
* Maps, as long as they are initialized, need a getter but not necessarily a setter, since they can be mutated by the binder.
771-
* Collections and arrays can be accessed either through an index (typically with YAML) or by using a single comma-separated value (properties).
772-
In the latter case, a setter is mandatory.
773-
We recommend to always add a setter for such types.
774-
If you initialize a collection, make sure it is not immutable (as in the preceding example).
775-
* If nested POJO properties are initialized (like the `Security` field in the preceding example), a setter is not required.
770+
* Pre-initialized Maps and Collections, as long as they are initialized with a mutable implementation (like the `roles` field in the preceding example).
771+
* Pre-initialized nested POJOs (like the `Security` field in the preceding example).
776772
If you want the binder to create the instance on the fly by using its default constructor, you need a setter.
777773
778774
Some people use Project Lombok to add getters and setters automatically.

0 commit comments

Comments
 (0)