NoUnboundElementsBindHandler (spring-boot 2.2.13.RELEASE)

java.lang.Object
- org.springframework.boot.context.properties.bind.AbstractBindHandler
- - org.springframework.boot.context.properties.bind.handler.NoUnboundElementsBindHandler

All Implemented Interfaces:

BindHandler
```
public class NoUnboundElementsBindHandler
extends AbstractBindHandler
```
BindHandler to enforce that all configuration properties under the root name have been bound.

Since:

2.0.0

Author:

Phillip Webb, Madhura Bhave

Field Summary
- Fields inherited from interface org.springframework.boot.context.properties.bind.BindHandler
  DEFAULT

Constructor Summary

Constructors
Constructor and Description
`NoUnboundElementsBindHandler(BindHandler parent)`
`NoUnboundElementsBindHandler(BindHandler parent, Function<ConfigurationPropertySource,Boolean> filter)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`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`	`onFinish(ConfigurationPropertyName name, Bindable<?> target, BindContext context, Object result)` Called when binding finishes with either bound or unbound result.
`<T> Bindable<T>`	`onStart(ConfigurationPropertyName name, Bindable<T> target, BindContext context)` Called when binding of an element starts but before any result has been determined.
`Object`	`onSuccess(ConfigurationPropertyName name, Bindable<?> target, BindContext context, Object result)` Called when binding of an element ends with a successful result.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.boot.context.properties.bind.BindHandler
onCreate

- Constructor Detail
  - NoUnboundElementsBindHandler
```
public NoUnboundElementsBindHandler(BindHandler parent)
```
  - NoUnboundElementsBindHandler
```
public NoUnboundElementsBindHandler(BindHandler parent,
                                    Function<ConfigurationPropertySource,Boolean> filter)
```
- Method Detail
  - onStart
```
public <T> Bindable<T> onStart(ConfigurationPropertyName name,
                               Bindable<T> target,
                               BindContext context)
```
    Description copied from interface: BindHandler
    
    Called when binding of an element starts but before any result has been determined.
    
    Specified by:
    
    onStart in interface BindHandler
    
    Overrides:
    
    onStart in class AbstractBindHandler
    
    Type Parameters:
    
    T - the bindable source type
    
    Parameters:
    
    name - the name of the element being bound
    
    target - the item being bound
    
    context - the bind context
    
    Returns:
    
    the actual item that should be used for binding (may be null)
  - onSuccess
```
public Object onSuccess(ConfigurationPropertyName name,
                        Bindable<?> target,
                        BindContext context,
                        Object result)
```
    Description copied from interface: BindHandler
    
    Called when binding of an element ends with a successful result. Implementations may change the ultimately returned result or perform addition validation.
    
    Specified by:
    
    onSuccess in interface BindHandler
    
    Overrides:
    
    onSuccess in class AbstractBindHandler
    
    Parameters:
    
    name - the name of the element being bound
    
    target - the item being bound
    
    context - the bind context
    
    result - the bound result (never null)
    
    Returns:
    
    the actual result that should be used (may be null)
  - onFailure
```
public Object onFailure(ConfigurationPropertyName name,
                        Bindable<?> target,
                        BindContext context,
                        Exception error)
                 throws Exception
```
    Description copied from interface: BindHandler
    
    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). Implementations may choose to swallow exceptions and return an alternative result.
    
    Specified by:
    
    onFailure in interface BindHandler
    
    Overrides:
    
    onFailure in class AbstractBindHandler
    
    Parameters:
    
    name - the name of the element being bound
    
    target - the item being bound
    
    context - the bind context
    
    error - the cause of the error (if the exception stands it may be re-thrown)
    
    Returns:
    
    the actual result that should be used (may be null).
    
    Throws:
    
    Exception - if the binding isn't valid
  - onFinish
```
public void onFinish(ConfigurationPropertyName name,
                     Bindable<?> target,
                     BindContext context,
                     Object result)
              throws Exception
```
    Description copied from interface: BindHandler
    
    Called when binding finishes with either bound or unbound result. This method will not be called when binding failed, even if a handler returns a result from BindHandler.onFailure(org.springframework.boot.context.properties.source.ConfigurationPropertyName, org.springframework.boot.context.properties.bind.Bindable<?>, org.springframework.boot.context.properties.bind.BindContext, java.lang.Exception).
    
    Specified by:
    
    onFinish in interface BindHandler
    
    Overrides:
    
    onFinish in class AbstractBindHandler
    
    Parameters:
    
    name - the name of the element being bound
    
    target - the item being bound
    
    context - the bind context
    
    result - the bound result (may be null)
    
    Throws:
    
    Exception - if the binding isn't valid

Class NoUnboundElementsBindHandler

Field Summary

Fields inherited from interface org.springframework.boot.context.properties.bind.BindHandler

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.springframework.boot.context.properties.bind.BindHandler

Constructor Detail

NoUnboundElementsBindHandler

NoUnboundElementsBindHandler

Method Detail

onStart

onSuccess

onFailure

onFinish