org.springframework.boot.context.properties

Annotation Type ImportAsConfigurationPropertiesBean

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Documented
 @EnableConfigurationProperties
 @ConfigurationProperties
 @Repeatable(value=ImportAsConfigurationPropertiesBeans.class)
 @Import(value=org.springframework.boot.context.properties.ImportAsConfigurationPropertiesBeanRegistrar.class)
public @interface ImportAsConfigurationPropertiesBean

Imports classes as @ConfigurationProperties beans. Can be used to import @ConfigurationProperties annotated types or third-party classes as configuration property beans.

Classes imported via this annotation that have a default constructor will use setter binding, those with a non-default constructor will use @ConstructorBinding. If you are looking to inject beans into a constructor, you should use a regular @Configuration class @Bean method instead.

The @ConfigurationProperties alias attributes defined on this class will only be used if the imported class is not itself annotated with@ConfigurationProperties.

Since:

2.4.0

Author:

Phillip Webb

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	ignoreInvalidFields Flag to indicate that when binding to this object invalid fields should be ignored.
boolean	ignoreUnknownFields Flag to indicate that when binding to this object unknown fields should be ignored.
String	prefix The prefix of the properties that are valid to bind to this object.
Class<?>[]	type One or more types that should be imported as a bean.
Class<?>[]	value One or more types that should be imported as a bean.

Element Detail

value

@AliasFor(value="type")
public abstract Class<?>[] value

One or more types that should be imported as a bean.

Returns:

the types to import

Default:

{}

type

@AliasFor(value="value")
public abstract Class<?>[] type

One or more types that should be imported as a bean.

Returns:

the types to import

Default:

{}

prefix

@AliasFor(annotation=ConfigurationProperties.class)
public abstract String prefix

The prefix of the properties that are valid to bind to this object. A valid prefix is defined by one or more words separated with dots (e.g. "acme.system.feature").

Returns:

the prefix of the properties to bind

See Also:

ConfigurationProperties.prefix()

Default:

""

ignoreInvalidFields

@AliasFor(annotation=ConfigurationProperties.class)
public abstract boolean ignoreInvalidFields

Flag to indicate that when binding to this object invalid fields should be ignored. Invalid means invalid according to the binder that is used, and usually this means fields of the wrong type (or that cannot be coerced into the correct type).

Returns:

the flag value (default false)

See Also:

ConfigurationProperties.ignoreInvalidFields()

Default:

false

ignoreUnknownFields

@AliasFor(annotation=ConfigurationProperties.class)
public abstract boolean ignoreUnknownFields

Flag to indicate that when binding to this object unknown fields should be ignored. An unknown field could be a sign of a mistake in the Properties.

Returns:

the flag value (default true)

See Also:

ConfigurationProperties.ignoreUnknownFields()

Default:

true