org.springframework.boot.context.properties.bind.validation

Class ValidationBindHandler

java.lang.Object

org.springframework.boot.context.properties.bind.AbstractBindHandler

org.springframework.boot.context.properties.bind.validation.ValidationBindHandler

All Implemented Interfaces:

BindHandler

public class ValidationBindHandler
extends AbstractBindHandler

BindHandler to apply Validators to bound results.

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
ValidationBindHandler(BindHandler parent, Validator... validators)
ValidationBindHandler(Validator... validators)

Method Summary

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) calls).
void	onFinish(ConfigurationPropertyName name, Bindable<?> target, BindContext context, Object result) Called when binding finishes, regardless of whether the property was bound or not.
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 org.springframework.boot.context.properties.bind.AbstractBindHandler

onStart

Methods inherited from class java.lang.Object

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

Constructor Detail

ValidationBindHandler

public ValidationBindHandler(Validator... validators)

ValidationBindHandler

public ValidationBindHandler(BindHandler parent,
                             Validator... validators)

Method Detail

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)

onFinish

public void onFinish(ConfigurationPropertyName name,
                     Bindable<?> target,
                     BindContext context,
                     Object result)
              throws Exception

Description copied from interface: BindHandler

Called when binding finishes, regardless of whether the property was bound or not.

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

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) 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