public interface BindHandler
binding
.Modifier and Type | Field and Description |
---|---|
static BindHandler |
DEFAULT
Default no-op bind handler.
|
Modifier and Type | Method and Description |
---|---|
default Object |
onFailure(ConfigurationPropertyName name,
Bindable<?> target,
BindContext context,
Exception error)
Called when binding fails for any reason (including failures from
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) calls). |
default void |
onFinish(ConfigurationPropertyName name,
Bindable<?> target,
BindContext context,
Object result)
Called when binding finishes, regardless of whether the property was bound or not.
|
default boolean |
onStart(ConfigurationPropertyName name,
Bindable<?> target,
BindContext context)
Called when binding of an element starts but before any result has been determined.
|
default Object |
onSuccess(ConfigurationPropertyName name,
Bindable<?> target,
BindContext context,
Object result)
Called when binding of an element ends with a successful result.
|
static final BindHandler DEFAULT
default boolean onStart(ConfigurationPropertyName name, Bindable<?> target, BindContext context)
name
- the name of the element being boundtarget
- the item being boundcontext
- the bind contexttrue
if binding should proceeddefault Object onSuccess(ConfigurationPropertyName name, Bindable<?> target, BindContext context, Object result)
name
- the name of the element being boundtarget
- the item being boundcontext
- the bind contextresult
- the bound result (never null
)null
)default Object onFailure(ConfigurationPropertyName name, Bindable<?> target, BindContext context, Exception error) throws Exception
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)
calls). Implementations may choose to swallow exceptions and
return an alternative result.name
- the name of the element being boundtarget
- the item being boundcontext
- the bind contexterror
- the cause of the error (if the exception stands it may be re-thrown)null
).Exception
- if the binding isn't validdefault void onFinish(ConfigurationPropertyName name, Bindable<?> target, BindContext context, Object result) throws Exception
name
- the name of the element being boundtarget
- the item being boundcontext
- the bind contextresult
- the bound result (may be null
)Exception
- if the binding isn't validCopyright © 2017 Pivotal Software, Inc.. All rights reserved.