ConfigurationPropertiesBean (spring-boot 2.2.1.RELEASE)

java.lang.Object
- org.springframework.boot.context.properties.ConfigurationPropertiesBean

```
public final class ConfigurationPropertiesBean
extends Object
```
Provides access to @ConfigurationProperties bean details, regardless of if the annotation was used directly or on a @Bean factory method. This class can be used to access all configuration properties beans in an ApplicationContext, or individual beans on a case-by-case basis (for example, in a BeanPostProcessor).

Since:

2.2.0

Author:

Phillip Webb

See Also:

getAll(ApplicationContext), get(ApplicationContext, Object, String)

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ConfigurationPropertiesBean.BindMethod
The binding method that is used for the bean.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ConfigurationPropertiesBean.BindMethod` The binding method that is used for the bean.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Bindable<?>`	`asBindTarget()` Return a `Bindable` instance suitable that can be used as a target for the `Binder`.
`static ConfigurationPropertiesBean`	`get(org.springframework.context.ApplicationContext applicationContext, Object bean, String beanName)` Return a `@ConfigurationPropertiesBean` instance for the given bean details or `null` if the bean is not a `@ConfigurationProperties` object.
`static Map<String,ConfigurationPropertiesBean>`	`getAll(org.springframework.context.ApplicationContext applicationContext)` Return all `@ConfigurationProperties` beans contained in the given application context.
`ConfigurationProperties`	`getAnnotation()` Return the `ConfigurationProperties` annotation for the bean.
`ConfigurationPropertiesBean.BindMethod`	`getBindMethod()` Return the property binding method that was used for the bean.
`Object`	`getInstance()` Return the actual Spring bean instance.
`String`	`getName()` Return the name of the Spring bean.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getName
```
public String getName()
```
    Return the name of the Spring bean.
    
    Returns:
    
    the bean name
  - getInstance
```
public Object getInstance()
```
    Return the actual Spring bean instance.
    
    Returns:
    
    the bean instance
  - getBindMethod
```
public ConfigurationPropertiesBean.BindMethod getBindMethod()
```
    Return the property binding method that was used for the bean.
    
    Returns:
    
    the bind type
  - getAnnotation
```
public ConfigurationProperties getAnnotation()
```
    Return the ConfigurationProperties annotation for the bean. The annotation may be defined on the bean itself or from the factory method that create the bean (usually a @Bean method).
    
    Returns:
    
    the configuration properties annotation
  - asBindTarget
```
public Bindable<?> asBindTarget()
```
    Return a Bindable instance suitable that can be used as a target for the Binder.
    
    Returns:
    
    a bind target for use with the Binder
  - getAll
```
public static Map<String,ConfigurationPropertiesBean> getAll(org.springframework.context.ApplicationContext applicationContext)
```
    Return all @ConfigurationProperties beans contained in the given application context. Both directly annotated beans, as well as beans that have @ConfigurationProperties annotated factory methods are included.
    
    Parameters:
    
    applicationContext - the source application context
    
    Returns:
    
    a map of all configuration properties beans keyed by the bean name
  - get
```
public static ConfigurationPropertiesBean get(org.springframework.context.ApplicationContext applicationContext,
                                              Object bean,
                                              String beanName)
```
    Return a @ConfigurationPropertiesBean instance for the given bean details or null if the bean is not a @ConfigurationProperties object. Annotations are considered both on the bean itself, as well as any factory method (for example a @Bean method).
    
    Parameters:
    
    applicationContext - the source application context
    
    bean - the bean to consider
    
    beanName - the bean name
    
    Returns:
    
    a configuration properties bean or null if the neither the bean or factory method are annotated with @ConfigurationProperties

Class ConfigurationPropertiesBean

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getName

getInstance

getBindMethod

getAnnotation

asBindTarget

getAll

get