root
/
spring-boot
mirror of https://github.com/spring-projects/spring-boot.git
1
0
Fork 0
Code Issues Actions 12 Packages Projects Releases Wiki Activity

Merge pull request #43827 from quaff 

* pr/43827:
  Polish "Mention @ConditionalOnBooleanProperty in reference document"
  Mention @ConditionalOnBooleanProperty in reference document

Closes gh-43827
This commit is contained in:
Moritz Halbritter 2025-01-15 13:26:57 +01:00
parent eef61c2ac9 ac330d7e37
commit ec647546cf
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/features/developing-auto-configuration.adoc
View File

@ -138,7 +138,8 @@ Providing as much type information as possible in javadoc:org.springframework.co
The javadoc:org.springframework.boot.autoconfigure.condition.ConditionalOnProperty[format=annotation] annotation lets configuration be included based on a Spring Environment property. The javadoc:org.springframework.boot.autoconfigure.condition.ConditionalOnProperty[format=annotation] annotation lets configuration be included based on a Spring Environment property.
Use the `prefix` and `name` attributes to specify the property that should be checked. Use the `prefix` and `name` attributes to specify the property that should be checked.
By default, any property that exists and is not equal to `false` is matched. By default, any property that exists and is not equal to `false` is matched.
You can also create more advanced checks by using the `havingValue` and `matchIfMissing` attributes. There is also a dedicated javadoc:org.springframework.boot.autoconfigure.condition.ConditionalOnBooleanProperty[format=annotation] annotation specifically made for boolean properties.
With both annotations you can also create more advanced checks by using the `havingValue` and `matchIfMissing` attributes.
If multiple names are given in the `name` attribute, all of the properties have to pass the test for the condition to match. If multiple names are given in the `name` attribute, all of the properties have to pass the test for the condition to match.