Package io.microsphere.spring.beans.factory.annotation

Annotation Type EnableConfigurationBeanBinding

@Target({TYPE,ANNOTATION_TYPE})
@Retention(RUNTIME)
@Documented
@Import(ConfigurationBeanBindingRegistrar.class)
@Repeatable(EnableConfigurationBeanBindings.class)
public @interface EnableConfigurationBeanBinding

Enables Spring's annotation-driven configuration bean from properties.

Since:

1.0.0

Author:

Mercy

See Also:

ConfigurationBeanBindingRegistrar, ConfigurationBeanBindingPostProcessor, ConfigurationBeanCustomizer

Field Summary

Fields

Modifier and Type	Fields	Description
static boolean	DEFAULT_IGNORE_INVALID_FIELDS	The default value for ignoreInvalidFields()
static boolean	DEFAULT_IGNORE_UNKNOWN_FIELDS	The default value for ignoreUnknownFields()
static boolean	DEFAULT_MULTIPLE	The default value for multiple()

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
java.lang.String	prefix	The name prefix of the properties that are valid to bind to the type of configuration.
java.lang.Class<?>	type

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
boolean	ignoreInvalidFields	Set whether to ignore invalid fields, that is, whether to ignore bind parameters that have corresponding fields in the target object which are not accessible (for example because of null values in the nested path).
boolean	ignoreUnknownFields	Set whether to ignore unknown fields, that is, whether to ignore bind parameters that do not have corresponding fields in the target object.
boolean	multiple	It indicates whether prefix() binding to multiple Spring Beans.

Field Detail

DEFAULT_MULTIPLE

static final boolean DEFAULT_MULTIPLE

The default value for multiple()

Since:

1.0.0

DEFAULT_IGNORE_UNKNOWN_FIELDS

static final boolean DEFAULT_IGNORE_UNKNOWN_FIELDS

The default value for ignoreUnknownFields()

Since:

1.0.0

DEFAULT_IGNORE_INVALID_FIELDS

static final boolean DEFAULT_IGNORE_INVALID_FIELDS

The default value for ignoreInvalidFields()

Since:

1.0.0

Element Detail

prefix

java.lang.String prefix

The name prefix of the properties that are valid to bind to the type of configuration.

Returns:

the name prefix of the properties to bind

type

java.lang.Class<?> type

Returns:

The binding type of configuration.

multiple

boolean multiple

It indicates whether prefix() binding to multiple Spring Beans.

Returns:

the default value is false

See Also:

DEFAULT_MULTIPLE

Default:

false

ignoreUnknownFields

boolean ignoreUnknownFields

Set whether to ignore unknown fields, that is, whether to ignore bind parameters that do not have corresponding fields in the target object.

Default is "true". Turn this off to enforce that all bind parameters must have a matching field in the target object.

Returns:

the default value is true

See Also:

DEFAULT_IGNORE_UNKNOWN_FIELDS

Default:

true

ignoreInvalidFields

boolean ignoreInvalidFields

Set whether to ignore invalid fields, that is, whether to ignore bind parameters that have corresponding fields in the target object which are not accessible (for example because of null values in the nested path).

Default is "true".

Returns:

the default value is true

See Also:

DEFAULT_IGNORE_INVALID_FIELDS

Default:

true