Skip to content

Commit

Permalink
Fix Kotlin example for empty @DefaultValue constructor binding
Browse files Browse the repository at this point in the history
Closes gh-32177
  • Loading branch information
wilkinsona committed Aug 31, 2022
1 parent 13c0cf7 commit 13edfba
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 7 deletions.
Expand Up @@ -730,11 +730,10 @@ Default values can be specified using `@DefaultValue` on a constructor parameter
The conversion service will be applied to coerce the `String` value to the target type of a missing property.

Referring to the previous example, if no properties are bound to `Security`, the `MyProperties` instance will contain a `null` value for `security`.
If you wish you return a non-null instance of `Security` even when no properties are bound to it, you can use an empty `@DefaultValue` annotation to do so:
To make it contain a non-null instance of `Security` even when no properties are bound to it (when using Kotlin, this will require the `username` and `password` parameters of `Security` to be declared as nullable as they do not have default values), use an empty `@DefaultValue` annotation:

include::code:nonnull/MyProperties[tag=*]


NOTE: To use constructor binding the class must be enabled using `@EnableConfigurationProperties` or configuration property scanning.
You cannot use constructor binding with beans that are created by the regular Spring mechanisms (for example `@Component` beans, beans created by using `@Bean` methods or beans loaded by using `@Import`)

Expand Down
Expand Up @@ -23,10 +23,12 @@ import java.net.InetAddress

@ConstructorBinding
@ConfigurationProperties("my.service")
class MyProperties(val isEnabled: Boolean, val remoteAddress: InetAddress,
@param:DefaultValue val security: Security) {
// tag::code[]
class MyProperties(val enabled: Boolean, val remoteAddress: InetAddress,
@DefaultValue val security: Security) {

class Security(val username: String, val password: String,
@param:DefaultValue("USER") val roles: List<String>)
class Security(val username: String?, val password: String?,
@param:DefaultValue("USER") val roles: List<String>)

}
}
// end::code[]

0 comments on commit 13edfba

Please sign in to comment.