| Package | Description | 
|---|---|
| org.springframework.boot.context.config | 
 External configuration support allowing 'application.properties' to be loaded and used
 within a Spring Boot application. 
 | 
| org.springframework.boot.context.properties | 
 Support for external configuration properties. 
 | 
| org.springframework.boot.context.properties.bind | 
 Support for  
@ConfigurationProperties binding. | 
| org.springframework.boot.context.properties.bind.handler | 
 General  
BindHandler implementations. | 
| org.springframework.boot.context.properties.bind.validation | 
 Binding validation support. 
 | 
| org.springframework.boot.context.properties.source | 
 Sources for external configuration properties. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
ConfigurationPropertyName | 
InvalidConfigDataPropertyException.getReplacement()
Return the replacement property that should be used instead or  
null if not
 replacement is available. | 
| Modifier and Type | Method and Description | 
|---|---|
Map<ConfigurationPropertyName,ConfigurationProperty> | 
BoundConfigurationProperties.getAll()
Get all bound properties. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
ConfigurationProperty | 
BoundConfigurationProperties.get(ConfigurationPropertyName name)
Get the configuration property bound to the given name. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
ConfigurationPropertyName | 
BindException.getName()
Return the name of the configuration property being bound. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
<T> BindResult<T> | 
Binder.bind(ConfigurationPropertyName name,
    Bindable<T> target)
Bind the specified target  
Bindable using this binder's
 property sources. | 
<T> BindResult<T> | 
Binder.bind(ConfigurationPropertyName name,
    Bindable<T> target,
    BindHandler handler)
Bind the specified target  
Bindable using this binder's
 property sources. | 
<T> T | 
Binder.bindOrCreate(ConfigurationPropertyName name,
            Bindable<T> target,
            BindHandler handler)
Bind the specified target  
Bindable using this binder's
 property sources or create a new instance using
 the type of the Bindable if the result of the binding is null. | 
default Object | 
BindHandler.onCreate(ConfigurationPropertyName name,
        Bindable<?> target,
        BindContext context,
        Object result)
Called when binding of an element ends with an unbound result and a newly created
 instance is about to be returned. 
 | 
Object | 
AbstractBindHandler.onFailure(ConfigurationPropertyName name,
         Bindable<?> target,
         BindContext context,
         Exception error)  | 
default Object | 
BindHandler.onFailure(ConfigurationPropertyName name,
         Bindable<?> target,
         BindContext context,
         Exception error)
Called when binding fails for any reason (including failures from
  
BindHandler.onSuccess(org.springframework.boot.context.properties.source.ConfigurationPropertyName, org.springframework.boot.context.properties.bind.Bindable<?>, org.springframework.boot.context.properties.bind.BindContext, java.lang.Object) or BindHandler.onCreate(org.springframework.boot.context.properties.source.ConfigurationPropertyName, org.springframework.boot.context.properties.bind.Bindable<?>, org.springframework.boot.context.properties.bind.BindContext, java.lang.Object) calls). | 
void | 
AbstractBindHandler.onFinish(ConfigurationPropertyName name,
        Bindable<?> target,
        BindContext context,
        Object result)  | 
default void | 
BindHandler.onFinish(ConfigurationPropertyName name,
        Bindable<?> target,
        BindContext context,
        Object result)
Called when binding finishes with either bound or unbound result. 
 | 
<T> Bindable<T> | 
AbstractBindHandler.onStart(ConfigurationPropertyName name,
       Bindable<T> target,
       BindContext context)  | 
default <T> Bindable<T> | 
BindHandler.onStart(ConfigurationPropertyName name,
       Bindable<T> target,
       BindContext context)
Called when binding of an element starts but before any result has been determined. 
 | 
Object | 
AbstractBindHandler.onSuccess(ConfigurationPropertyName name,
         Bindable<?> target,
         BindContext context,
         Object result)  | 
default Object | 
BindHandler.onSuccess(ConfigurationPropertyName name,
         Bindable<?> target,
         BindContext context,
         Object result)
Called when binding of an element ends with a successful result. 
 | 
Object | 
BoundPropertiesTrackingBindHandler.onSuccess(ConfigurationPropertyName name,
         Bindable<?> target,
         BindContext context,
         Object result)  | 
| Modifier and Type | Method and Description | 
|---|---|
Object | 
NoUnboundElementsBindHandler.onFailure(ConfigurationPropertyName name,
         Bindable<?> target,
         BindContext context,
         Exception error)  | 
Object | 
IgnoreErrorsBindHandler.onFailure(ConfigurationPropertyName name,
         Bindable<?> target,
         BindContext context,
         Exception error)  | 
Object | 
IgnoreTopLevelConverterNotFoundBindHandler.onFailure(ConfigurationPropertyName name,
         Bindable<?> target,
         BindContext context,
         Exception error)  | 
void | 
NoUnboundElementsBindHandler.onFinish(ConfigurationPropertyName name,
        Bindable<?> target,
        BindContext context,
        Object result)  | 
<T> Bindable<T> | 
NoUnboundElementsBindHandler.onStart(ConfigurationPropertyName name,
       Bindable<T> target,
       BindContext context)  | 
Object | 
NoUnboundElementsBindHandler.onSuccess(ConfigurationPropertyName name,
         Bindable<?> target,
         BindContext context,
         Object result)  | 
| Modifier and Type | Method and Description | 
|---|---|
ConfigurationPropertyName | 
ValidationErrors.getName()
Return the name of the item that was being validated. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
Object | 
ValidationBindHandler.onFailure(ConfigurationPropertyName name,
         Bindable<?> target,
         BindContext context,
         Exception error)  | 
void | 
ValidationBindHandler.onFinish(ConfigurationPropertyName name,
        Bindable<?> target,
        BindContext context,
        Object result)  | 
<T> Bindable<T> | 
ValidationBindHandler.onStart(ConfigurationPropertyName name,
       Bindable<T> target,
       BindContext context)  | 
Object | 
ValidationBindHandler.onSuccess(ConfigurationPropertyName name,
         Bindable<?> target,
         BindContext context,
         Object result)  | 
| Modifier and Type | Field and Description | 
|---|---|
static ConfigurationPropertyName | 
ConfigurationPropertyName.EMPTY
An empty  
ConfigurationPropertyName. | 
| Modifier and Type | Method and Description | 
|---|---|
static ConfigurationPropertyName | 
ConfigurationPropertyName.adapt(CharSequence name,
     char separator)
Create a  
ConfigurationPropertyName by adapting the given source. | 
ConfigurationPropertyName | 
ConfigurationPropertyName.append(ConfigurationPropertyName suffix)
Create a new  
ConfigurationPropertyName by appending the given suffix. | 
ConfigurationPropertyName | 
ConfigurationPropertyName.append(String suffix)
Create a new  
ConfigurationPropertyName by appending the given suffix. | 
ConfigurationPropertyName | 
ConfigurationPropertyName.chop(int size)
Return a new  
ConfigurationPropertyName by chopping this name to the given
 size. | 
ConfigurationPropertyName | 
ConfigurationProperty.getName()  | 
ConfigurationPropertyName | 
ConfigurationPropertyNameAliases.getNameForAlias(ConfigurationPropertyName alias)  | 
ConfigurationPropertyName | 
ConfigurationPropertyName.getParent()
Return the parent of this  
ConfigurationPropertyName or
 EMPTY if there is no parent. | 
static ConfigurationPropertyName | 
ConfigurationPropertyName.of(CharSequence name)
Return a  
ConfigurationPropertyName for the specified string. | 
static ConfigurationPropertyName | 
ConfigurationPropertyName.ofIfValid(CharSequence name)
Return a  
ConfigurationPropertyName for the specified string or null
 if the name is not valid. | 
ConfigurationPropertyName | 
ConfigurationPropertyName.subName(int offset)
Return a new  
ConfigurationPropertyName by based on this name offset by
 specific element index. | 
| Modifier and Type | Method and Description | 
|---|---|
List<ConfigurationPropertyName> | 
ConfigurationPropertyNameAliases.getAliases(ConfigurationPropertyName name)  | 
default Iterator<ConfigurationPropertyName> | 
IterableConfigurationPropertySource.iterator()
Return an iterator for the  
names managed by this
 source. | 
Iterator<ConfigurationPropertyName> | 
MapConfigurationPropertySource.iterator()  | 
Iterator<ConfigurationPropertyName> | 
ConfigurationPropertyNameAliases.iterator()  | 
Stream<ConfigurationPropertyName> | 
IterableConfigurationPropertySource.stream()
Returns a sequential  
Stream for the names
 managed by this source. | 
Stream<ConfigurationPropertyName> | 
MapConfigurationPropertySource.stream()  | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
ConfigurationPropertyNameAliases.addAliases(ConfigurationPropertyName name,
          ConfigurationPropertyName... aliases)  | 
void | 
ConfigurationPropertyNameAliases.addAliases(ConfigurationPropertyName name,
          ConfigurationPropertyName... aliases)  | 
ConfigurationPropertyName | 
ConfigurationPropertyName.append(ConfigurationPropertyName suffix)
Create a new  
ConfigurationPropertyName by appending the given suffix. | 
int | 
ConfigurationPropertyName.compareTo(ConfigurationPropertyName other)  | 
default ConfigurationPropertyState | 
IterableConfigurationPropertySource.containsDescendantOf(ConfigurationPropertyName name)  | 
default ConfigurationPropertyState | 
ConfigurationPropertySource.containsDescendantOf(ConfigurationPropertyName name)
Returns if the source contains any descendants of the specified name. 
 | 
List<ConfigurationPropertyName> | 
ConfigurationPropertyNameAliases.getAliases(ConfigurationPropertyName name)  | 
ConfigurationProperty | 
ConfigurationPropertySource.getConfigurationProperty(ConfigurationPropertyName name)
Return a single  
ConfigurationProperty from the source or null if no
 property can be found. | 
ConfigurationProperty | 
MapConfigurationPropertySource.getConfigurationProperty(ConfigurationPropertyName name)  | 
ConfigurationPropertyName | 
ConfigurationPropertyNameAliases.getNameForAlias(ConfigurationPropertyName alias)  | 
boolean | 
ConfigurationPropertyName.isAncestorOf(ConfigurationPropertyName name)
Returns  
true if this element is an ancestor (immediate or nested parent) of
 the specified name. | 
boolean | 
ConfigurationPropertyName.isParentOf(ConfigurationPropertyName name)
Returns  
true if this element is an immediate parent of the specified name. | 
| Modifier and Type | Method and Description | 
|---|---|
default IterableConfigurationPropertySource | 
IterableConfigurationPropertySource.filter(Predicate<ConfigurationPropertyName> filter)  | 
default ConfigurationPropertySource | 
ConfigurationPropertySource.filter(Predicate<ConfigurationPropertyName> filter)
Return a filtered variant of this source, containing only names that match the
 given  
Predicate. | 
| Constructor and Description | 
|---|
ConfigurationProperty(ConfigurationPropertyName name,
                     Object value,
                     Origin origin)  | 
ConfigurationPropertyNameAliases(ConfigurationPropertyName name,
                                ConfigurationPropertyName... aliases)  | 
ConfigurationPropertyNameAliases(ConfigurationPropertyName name,
                                ConfigurationPropertyName... aliases)  |