Package com.vaadin.flow.data.binder

Class BindingValidationStatus<TARGET>

java.lang.Object

com.vaadin.flow.data.binder.BindingValidationStatus<TARGET>

Type Parameters:

TARGET - the target data type of the binding for which the validation status changed, matches the field type unless a converter has been set

All Implemented Interfaces:

Serializable

public class BindingValidationStatus<TARGET>
extends Object
implements Serializable

Represents the status of field validation. Status can be Status.OK, Status.ERROR or Status.UNRESOLVED. Status OK and ERROR are always associated with a ValidationResult getResult().

Use Binder.BindingBuilder.withValidationStatusHandler(BindingValidationStatusHandler) to register a handler for field level validation status changes.

Since:

1.0

Author:

Vaadin Ltd

See Also:

• Binder.BindingBuilder.withValidationStatusHandler(BindingValidationStatusHandler)
• Binder.Binding.validate()
• BindingValidationStatusHandler
• BinderValidationStatus
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	BindingValidationStatus.Status	Status of the validation.

Constructor Summary

Constructors

Constructor	Description
BindingValidationStatus(Result<TARGET> result, Binder.Binding<?,TARGET> source)	Creates a new status change event.

Method Summary

Modifier and Type	Method	Description
static <TARGET> BindingValidationStatus<TARGET>	createUnresolvedStatus(Binder.Binding<?,TARGET> source)	Convenience method for creating a BindingValidationStatus.Status.UNRESOLVED validation status for the given binding.
Binder.Binding<?,TARGET>	getBinding()	Gets the source binding of the validation status.
HasValue<?,?>	getField()	Gets the bound field for this status.
Optional<String>	getMessage()	Gets error validation message if status is BindingValidationStatus.Status.ERROR.
Optional<ValidationResult>	getResult()	Gets the validation result if status is either BindingValidationStatus.Status.OK or BindingValidationStatus.Status.ERROR or an empty optional if status is BindingValidationStatus.Status.UNRESOLVED.
BindingValidationStatus.Status	getStatus()	Gets status of the validation.
List<ValidationResult>	getValidationResults()	Gets all the validation results related to this binding validation status.
boolean	isError()	Gets whether the validation failed or not.

Methods inherited from class java.lang.Object

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

Constructor Details

BindingValidationStatus

public BindingValidationStatus(Result<TARGET> result,
 Binder.Binding<?,TARGET> source)

Creates a new status change event.

If result is null, the status is BindingValidationStatus.Status.UNRESOLVED.

Parameters:

result - the related result object, may be null

source - field whose status has changed, not null

Method Details

createUnresolvedStatus

public static <TARGET>
BindingValidationStatus<TARGET> createUnresolvedStatus(Binder.Binding<?,TARGET> source)

Convenience method for creating a BindingValidationStatus.Status.UNRESOLVED validation status for the given binding.

Type Parameters:

TARGET - the target data type of the binding for which the validation status was reset

Parameters:

source - the source binding

Returns:

unresolved validation status

getStatus

public BindingValidationStatus.Status getStatus()

Gets status of the validation.

Returns:

status

isError

public boolean isError()

Gets whether the validation failed or not.

Returns:

true if validation failed, false if validation passed

getMessage

public Optional<String> getMessage()

Gets error validation message if status is BindingValidationStatus.Status.ERROR.

Returns:

an optional validation error status or an empty optional if status is not an error

getResult

public Optional<ValidationResult> getResult()

Gets the validation result if status is either BindingValidationStatus.Status.OK or BindingValidationStatus.Status.ERROR or an empty optional if status is BindingValidationStatus.Status.UNRESOLVED.

Returns:

the validation result

getValidationResults

public List<ValidationResult> getValidationResults()

Gets all the validation results related to this binding validation status.

Returns:

list of validation results

getBinding

public Binder.Binding<?,TARGET> getBinding()

Gets the source binding of the validation status.

Returns:

the source binding

getField

public HasValue<?,?> getField()

Gets the bound field for this status.

Returns:

the field