From e20aa7dc731960ba73a16c144cc2599f9b77a2ba Mon Sep 17 00:00:00 2001 From: Phillip Webb Date: Mon, 14 Oct 2019 20:49:04 -0700 Subject: [PATCH] Clarify ConfigurationPropertiesBean Javadoc Update the `ConfigurationPropertiesBean` Javadoc to clarify its purpose. Closes gh-18487 --- .../properties/ConfigurationPropertiesBean.java | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/properties/ConfigurationPropertiesBean.java b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/properties/ConfigurationPropertiesBean.java index 7af2a754a5..ed1e85f2e2 100644 --- a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/properties/ConfigurationPropertiesBean.java +++ b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/properties/ConfigurationPropertiesBean.java @@ -27,6 +27,7 @@ import org.springframework.aop.support.AopUtils; import org.springframework.beans.BeanUtils; import org.springframework.beans.factory.NoSuchBeanDefinitionException; import org.springframework.beans.factory.config.BeanDefinition; +import org.springframework.beans.factory.config.BeanPostProcessor; import org.springframework.beans.factory.config.ConfigurableListableBeanFactory; import org.springframework.beans.factory.support.RootBeanDefinition; import org.springframework.boot.context.properties.bind.Bindable; @@ -43,13 +44,17 @@ import org.springframework.util.Assert; import org.springframework.validation.annotation.Validated; /** - * Provides access to {@link ConfigurationProperties} beans from an - * {@link ApplicationContext}. + * Provides access to {@link ConfigurationProperties @ConfigurationProperties} bean + * details, regardless of if the annotation was used directly or on a {@link Bean @Bean} + * factory method. This class can be used to access {@link #getAll(ApplicationContext) + * all} configuration properties beans in an ApplicationContext, or + * {@link #get(ApplicationContext, Object, String) individual beans} on a case-by-case + * basis (for example, in a {@link BeanPostProcessor}). * * @author Phillip Webb * @since 2.2.0 - * @see #get(ApplicationContext, Object, String) * @see #getAll(ApplicationContext) + * @see #get(ApplicationContext, Object, String) */ public final class ConfigurationPropertiesBean {