We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.data.
Class BindingValidationStatus<TARGET>
- java.lang.Object
-
- com.vaadin.data.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 setAll Implemented Interfaces:
public class BindingValidationStatus<TARGET> extends Object implements SerializableRepresents the status of field validation. Status can be
Status.OK,Status.ERRORorStatus.UNRESOLVED. Status OK and ERROR are always associated with a ValidationResultgetResult().Use
Binder.BindingBuilder.withValidationStatusHandler(BindingValidationStatusHandler)to register a handler for field level validation status changes.Since:
8.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 classBindingValidationStatus.StatusStatus of the validation.
-
Constructor Summary
Constructors Constructor Description BindingValidationStatus(Binder.Binding<?,TARGET> source, BindingValidationStatus.Status status, ValidationResult result)Deprecated.
BindingValidationStatus(Binder.Binding<?,TARGET> source, ValidationResult result)Deprecated.
BindingValidationStatus(Result<TARGET> result, Binder.Binding<?,TARGET> source)Creates a new status change event.
-
Method Summary
All Methods Modifier and Type Method Description static <TARGET> BindingValidationStatus<TARGET>createUnresolvedStatus(Binder.Binding<?,TARGET> source)Convenience method for creating a
BindingValidationStatus.Status.UNRESOLVEDvalidation 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.OKorBindingValidationStatus.Status.ERRORor an empty optional if status isBindingValidationStatus.Status.UNRESOLVED.BindingValidationStatus.StatusgetStatus()Gets status of the validation.
List<ValidationResult>getValidationResults()Gets all the validation results related to this binding validation status.
booleanisError()Gets whether the validation failed or not.
-
-
-
Constructor Detail
-
BindingValidationStatus
@Deprecated public BindingValidationStatus(Binder.Binding<?,TARGET> source, ValidationResult result)Deprecated.Creates a new validation status for the given binding and validation result.
Parameters:
source- the source bindingresult- the result of the validation
-
BindingValidationStatus
@Deprecated public BindingValidationStatus(Binder.Binding<?,TARGET> source, BindingValidationStatus.Status status, ValidationResult result)Deprecated.Creates a new status change event.
The
messagemust benullif thestatusisBindingValidationStatus.Status.OK.Parameters:
source- field whose status has changed, notnullstatus- updated status value, notnullresult- the related result, may benull
-
BindingValidationStatus
public BindingValidationStatus(Result<TARGET> result, Binder.Binding<?,TARGET> source)Creates a new status change event.
If
resultisnull, thestatusisBindingValidationStatus.Status.UNRESOLVED.Parameters:
result- the related result object, may benullsource- field whose status has changed, notnullSince:
8.2
-
-
Method Detail
-
createUnresolvedStatus
public static <TARGET> BindingValidationStatus<TARGET> createUnresolvedStatus(Binder.Binding<?,TARGET> source)Convenience method for creating a
BindingValidationStatus.Status.UNRESOLVEDvalidation status for the given binding.Type Parameters:
TARGET- the target data type of the binding for which the validation status was resetParameters:
source- the source bindingReturns:
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:
trueif validation failed,falseif 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.OKorBindingValidationStatus.Status.ERRORor an empty optional if status isBindingValidationStatus.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
Since:
8.2
-
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
-
-