Package io.microsphere.spring.boot.context.properties

Class ConfigurationPropertiesBeanInfo

java.lang.Object

io.microsphere.spring.boot.context.properties.ConfigurationPropertiesBeanInfo

public class ConfigurationPropertiesBeanInfo
extends Object

The information class for introspecting the bean annotated @ConfigurationProperties.

Example Usage

 // Create instance with bean class only
 ConfigurationPropertiesBeanInfo info = new ConfigurationPropertiesBeanInfo(MyConfiguration.class);

 // Create instance with bean class and annotation
 ConfigurationProperties annotation = MyConfiguration.class.getAnnotation(ConfigurationProperties.class);
 ConfigurationPropertiesBeanInfo info = new ConfigurationPropertiesBeanInfo(MyConfiguration.class, annotation);

 // Create instance with all parameters
 ConfigurationPropertiesBeanInfo info = new ConfigurationPropertiesBeanInfo(
     MyConfiguration.class,
     annotation,
     "my.config.prefix"
 );

 // Access properties
 Class<?> beanClass = info.getBeanClass();
 String prefix = info.getPrefix();
 List<PropertyDescriptor> descriptors = info.getPropertyDescriptors();
 PropertyDescriptor descriptor = info.getPropertyDescriptor("propertyName");
 

Since:

1.0.0

Author:

Mercy

See Also:

• ConfigurationProperties

Constructor Summary

Constructors

Constructor	Description
ConfigurationPropertiesBeanInfo(Class<?> beanClass)
ConfigurationPropertiesBeanInfo(Class<?> beanClass, org.springframework.boot.context.properties.ConfigurationProperties annotation)
ConfigurationPropertiesBeanInfo(Class<?> beanClass, org.springframework.boot.context.properties.ConfigurationProperties annotation, String prefix)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
org.springframework.boot.context.properties.ConfigurationProperties	getAnnotation()
Class<?>	getBeanClass()
String	getPrefix()
PropertyDescriptor	getPropertyDescriptor(String name)
List<PropertyDescriptor>	getPropertyDescriptors()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ConfigurationPropertiesBeanInfo

public ConfigurationPropertiesBeanInfo(Class<?> beanClass)

ConfigurationPropertiesBeanInfo

public ConfigurationPropertiesBeanInfo(Class<?> beanClass,
 org.springframework.boot.context.properties.ConfigurationProperties annotation)

ConfigurationPropertiesBeanInfo

public ConfigurationPropertiesBeanInfo(Class<?> beanClass,
 org.springframework.boot.context.properties.ConfigurationProperties annotation,
 String prefix)
                                throws IllegalArgumentException

Parameters:

beanClass - the bean class

annotation - the annotation

prefix - the prefix of property name

Throws:

IllegalArgumentException - if any argument is null

Method Details

getBeanClass

public Class<?> getBeanClass()

getAnnotation

public org.springframework.boot.context.properties.ConfigurationProperties getAnnotation()

getPrefix

public String getPrefix()

getPropertyDescriptors

public List<PropertyDescriptor> getPropertyDescriptors()

getPropertyDescriptor

public PropertyDescriptor getPropertyDescriptor(String name)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object