org.springframework.boot.bind

Class PropertySourcesBinder

java.lang.Object

org.springframework.boot.bind.PropertySourcesBinder

public class PropertySourcesBinder
extends Object

Helper extracting info from PropertySources.

Since:

1.4.0

Author:

Stephane Nicoll

Constructor Summary

Constructors

Constructor and Description
PropertySourcesBinder(ConfigurableEnvironment environment) Create a new instance using the Environment as the property sources.
PropertySourcesBinder(PropertySource<?> propertySource) Create a new instance from a single PropertySource.
PropertySourcesBinder(PropertySources propertySources) Create a new instance.

Method Summary

Modifier and Type	Method and Description
void	bindTo(String prefix, Object target) Bind the specified target from the environment using the prefix.
Map<String,Object>	extractAll(String prefix) Extract the keys using the specified prefix.
ConversionService	getConversionService()
PropertySources	getPropertySources()
void	setConversionService(ConversionService conversionService)
void	setPropertySources(PropertySources propertySources)

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertySourcesBinder

public PropertySourcesBinder(PropertySources propertySources)

Create a new instance.

Parameters:

propertySources - the PropertySources to use

PropertySourcesBinder

public PropertySourcesBinder(PropertySource<?> propertySource)

Create a new instance from a single PropertySource.

Parameters:

propertySource - the PropertySource to use

PropertySourcesBinder

public PropertySourcesBinder(ConfigurableEnvironment environment)

Create a new instance using the Environment as the property sources.

Parameters:

environment - the environment

Method Detail

setPropertySources

public void setPropertySources(PropertySources propertySources)

getPropertySources

public PropertySources getPropertySources()

setConversionService

public void setConversionService(ConversionService conversionService)

getConversionService

public ConversionService getConversionService()

extractAll

public Map<String,Object> extractAll(String prefix)

Extract the keys using the specified prefix. The prefix won't be included.

Any key that starts with the prefix will be included.

Parameters:

prefix - the prefix to use

Returns:

the keys matching the prefix

bindTo

public void bindTo(String prefix,
                   Object target)

Bind the specified target from the environment using the prefix.

Any key that starts with the prefix will be bound to the target.

Parameters:

prefix - the prefix to use

target - the object to bind to