Refactor Binder Status Handling API

BinderStatusHandler is now triggered only once per validation. Unified ValidationError and BinderResult into BinderValidationStatus. Renamed ValidationStatusChangeEvent into ValidationStatus. Unified handler names for validation status. Next patch will fix resetting of field errors on reset. Change-Id: I9536d554d781fe599fbd7e5bcb5a9ffebe675ca0
vaadin · Sep 12, 2016 · 28f5c84 · 28f5c84
1 parent 363dce9
commit 28f5c84
Show file tree

Hide file tree

Showing 15 changed files with 886 additions and 640 deletions.
diff --git a/documentation/datamodel/datamodel-forms.asciidoc b/documentation/datamodel/datamodel-forms.asciidoc
@@ -323,11 +323,11 @@ Even if the user has not edited a field, all validation error will be shown if w
 binder.load(new Person());
 
 // This will make all current validation errors visible
-List<ValidationError<?>> validationErrors = binder.validate();
+ValidationStatus<Person> status = binder.validate();
 
-if (!validationErrors.isEmpty()) {
+if (status.hasErrors()) {
   Notification.show("Validation error count: "
-    + validationErrors.size());
+    + status.getValidationErrors().size());
 }
 ----
 
@@ -341,7 +341,7 @@ Handling a checked exception::
 ----
 try {
   binder.save(person);
-} catch (BindingException e) {
+} catch (ValidationException e) {
   Notification.show("Validation error count: "
     + e.getValidationErrors().size());
 }
@@ -566,21 +566,17 @@ We can also define our own status handler to provide a custom way of handling st
 ----
 BinderStatusHandler defaultHandler = binder.getStatusHandler();
 
-binder.setStatusHandler(results -> {
+binder.setStatusHandler(status -> {
-  String errorMessage = results.stream()
+    // create an error message on failed bean level validations
-    // Ignore helper and confirmation messages
+    List<Result<?>> errors = status.getBeanValidationErrors();
-    .filter(BinderResult::isError)
+    String errorMessage = errors.stream().map(Result::getMessage)
-    // Ignore messages that belong to a specific field
+        .map(o -> o.get()).collect(Collectors.joining("\n"));
-    .filter(error -> !error.getField().isPresent())
+    // show error in a label
-    // Create a string out of the remaining messages
+    formStatusLabel.setValue(errorMessage);
-    .map(Result::getMessage).map(o -> o.get())
+    formStatusLabel.setVisible(!errorMessage.isEmpty());
-    .collect(Collectors.joining("\n"));
+
-
+    // Let the default handler show messages for each field
-  formStatusLabel.setValue(errorMessage);
+    defaultHandler.accept(status);
-  formStatusLabel.setVisible(!errorMessage.isEmpty());
-
-  // Let the default handler show messages for each field
-  defaultHandler.accept(event);
 });
 ----
 

diff --git a/server/src/main/java/com/vaadin/data/BeanBinder.java b/server/src/main/java/com/vaadin/data/BeanBinder.java
@@ -149,7 +149,7 @@ protected static class BeanBindingImpl<BEAN, FIELDVALUE, TARGET>
         protected BeanBindingImpl(BeanBinder<BEAN> binder,
                 HasValue<FIELDVALUE> field,
                 Converter<FIELDVALUE, TARGET> converter,
-                StatusChangeHandler statusChangeHandler) {
+                ValidationStatusHandler statusChangeHandler) {
             super(binder, field, converter, statusChangeHandler);
         }
 
@@ -318,7 +318,7 @@ public BeanBinder<BEAN> withValidator(Validator<? super BEAN> validator) {
     @Override
     protected <FIELDVALUE, TARGET> BeanBindingImpl<BEAN, FIELDVALUE, TARGET> createBinding(
             HasValue<FIELDVALUE> field, Converter<FIELDVALUE, TARGET> converter,
-            StatusChangeHandler handler) {
+            ValidationStatusHandler handler) {
         Objects.requireNonNull(field, "field cannot be null");
         Objects.requireNonNull(converter, "converter cannot be null");
         return new BeanBindingImpl<>(this, field, converter, handler);