org.springframework.boot.context.properties

Annotation Type ConfigurationProperties

@Target(value={TYPE,METHOD})
 @Retention(value=RUNTIME)
 @Documented
public @interface ConfigurationProperties

Annotation for externalized configuration. Add this to a class definition or a @Bean method in a @Configuration class if you want to bind and validate some external Properties (e.g. from a .properties file).

Note that contrary to @Value, SpEL expressions are not evaluated since property values are externalized.

Author:

Dave Syer

See Also:

ConfigurationPropertiesBindingPostProcessor, EnableConfigurationProperties

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	exceptionIfInvalid Flag to indicate that an exception should be raised if a Validator is available and validation fails.
boolean	ignoreInvalidFields Flag to indicate that when binding to this object invalid fields should be ignored.
boolean	ignoreNestedProperties Flag to indicate that when binding to this object fields with periods in their names should be ignored.
boolean	ignoreUnknownFields Flag to indicate that when binding to this object unknown fields should be ignored.
String[]	locations Deprecated. as of 1.4 in favor of configuring the environment directly with additional locations
boolean	merge Deprecated. as of 1.4 along with locations() in favor of configuring the environment directly with additional locations
String	prefix The name prefix of the properties that are valid to bind to this object.
String	value The name prefix of the properties that are valid to bind to this object.

Element Detail

value

public abstract String value

The name prefix of the properties that are valid to bind to this object. Synonym for prefix().

Returns:

the name prefix of the properties to bind

Default:

""

prefix

public abstract String prefix

The name prefix of the properties that are valid to bind to this object. Synonym for value().

Returns:

the name prefix of the properties to bind

Default:

""

ignoreInvalidFields

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)

Default:

false

ignoreNestedProperties

public abstract boolean ignoreNestedProperties

Flag to indicate that when binding to this object fields with periods in their names should be ignored.

Returns:

the flag value (default false)

Default:

false

ignoreUnknownFields

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)

Default:

true

exceptionIfInvalid

public abstract boolean exceptionIfInvalid

Flag to indicate that an exception should be raised if a Validator is available and validation fails. If it is set to false, validation errors will be swallowed. They will be logged, but not propagated to the caller.

Returns:

the flag value (default true)

Default:

true

locations

@Deprecated
public abstract String[] locations

Deprecated. as of 1.4 in favor of configuring the environment directly with additional locations

Optionally provide explicit resource locations to bind to. By default the configuration at these specified locations will be merged with the default configuration. These resources take precedence over any other property sources defined in the environment.

Returns:

the path (or paths) of resources to bind to

See Also:

merge()

Default:

{}

merge

@Deprecated
public abstract boolean merge

Deprecated. as of 1.4 along with locations() in favor of configuring the environment directly with additional locations

Flag to indicate that configuration loaded from the specified locations should be merged with the default configuration.

Returns:

the flag value (default true)

See Also:

locations()

Default:

true