Constructor Detail

• AbstractBindHandler

  public AbstractBindHandler()

  Create a new binding handler instance.

• AbstractBindHandler

  public AbstractBindHandler(BindHandler parent)

  Create a new binding handler instance with a specific parent.

  Parameters:

  parent - the parent handler

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

  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

  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) calls). Implementations may choose to swallow exceptions and return an alternative result.

  Specified by:

  onFailure in interface BindHandler

  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

  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