org.springframework.boot.context.properties

Class ConfigurationPropertiesBinderBuilder

java.lang.Object

org.springframework.boot.context.properties.ConfigurationPropertiesBinderBuilder

public class ConfigurationPropertiesBinderBuilder
extends Object

Builder for creating ConfigurationPropertiesBinder based on the state of the ApplicationContext.

Since:

2.0.0

Author:

Stephane Nicoll

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONVERSION_SERVICE_BEAN_NAME The bean name of the configuration properties conversion service.
static String	VALIDATOR_BEAN_NAME The bean name of the configuration properties validator.

Constructor Summary

Constructors

Constructor and Description
ConfigurationPropertiesBinderBuilder(org.springframework.context.ApplicationContext applicationContext) Creates an instance with the ApplicationContext to use.

Method Summary

Modifier and Type	Method and Description
ConfigurationPropertiesBinder	build() Build a ConfigurationPropertiesBinder based on the state of the builder, discovering the ConversionService and Validator if necessary.
ConfigurationPropertiesBinderBuilder	withConversionService(org.springframework.core.convert.ConversionService conversionService) Specify the ConversionService to use or null to use the default.
ConfigurationPropertiesBinderBuilder	withEnvironment(org.springframework.core.env.ConfigurableEnvironment environment) Specify the Environment to use, use all available PropertySource.
ConfigurationPropertiesBinderBuilder	withPropertySources(Iterable<org.springframework.core.env.PropertySource<?>> propertySources) Specify the property sources to use.
ConfigurationPropertiesBinderBuilder	withValidator(org.springframework.validation.Validator validator) Specify the Validator to use or null to use the default.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VALIDATOR_BEAN_NAME

public static final String VALIDATOR_BEAN_NAME

The bean name of the configuration properties validator.

See Also:

Constant Field Values

CONVERSION_SERVICE_BEAN_NAME

public static final String CONVERSION_SERVICE_BEAN_NAME

The bean name of the configuration properties conversion service.

See Also:

Constant Field Values

Constructor Detail

ConfigurationPropertiesBinderBuilder

public ConfigurationPropertiesBinderBuilder(org.springframework.context.ApplicationContext applicationContext)

Creates an instance with the ApplicationContext to use.

Parameters:

applicationContext - the application context

Method Detail

withConversionService

public ConfigurationPropertiesBinderBuilder withConversionService(org.springframework.core.convert.ConversionService conversionService)

Specify the ConversionService to use or null to use the default.

By default, use a ConversionService bean named "conversionService" if any. Otherwise create a DefaultConversionService with any ConfigurationPropertiesBinding qualified Converter and GenericConverter beans found in the context.

Parameters:

conversionService - the conversion service to use or null

Returns:

this instance

withValidator

public ConfigurationPropertiesBinderBuilder withValidator(org.springframework.validation.Validator validator)

Specify the Validator to use or null to use the default.

By default, use a Validator bean named "configurationPropertiesValidator" if any. If not, create a JSR 303 Validator if the necessary libraries are available. No validation occurs otherwise.

Parameters:

validator - the validator to use or null

Returns:

this instance

withPropertySources

public ConfigurationPropertiesBinderBuilder withPropertySources(Iterable<org.springframework.core.env.PropertySource<?>> propertySources)

Specify the property sources to use.

Parameters:

propertySources - the configuration the binder should use

Returns:

this instance

See Also:

withEnvironment(ConfigurableEnvironment)

withEnvironment

public ConfigurationPropertiesBinderBuilder withEnvironment(org.springframework.core.env.ConfigurableEnvironment environment)

Specify the Environment to use, use all available PropertySource.

Parameters:

environment - the environment to use

Returns:

this instance

See Also:

withPropertySources(Iterable)

build

public ConfigurationPropertiesBinder build()

Build a ConfigurationPropertiesBinder based on the state of the builder, discovering the ConversionService and Validator if necessary.

Returns:

a ConfigurationPropertiesBinder