Rename setRequired to asRequired since it's logically not a setter (#…

…7986)
vaadin · Dec 14, 2016 · b2e3aa2 · b2e3aa2
1 parent fc011f6
commit b2e3aa2
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 17 deletions.
diff --git a/server/src/main/java/com/vaadin/data/BeanBinder.java b/server/src/main/java/com/vaadin/data/BeanBinder.java
@@ -97,13 +97,13 @@ default BeanBindingBuilder<BEAN, TARGET> withNullRepresentation(
         }
 
         @Override
-        public BeanBindingBuilder<BEAN, TARGET> setRequired(
+        public BeanBindingBuilder<BEAN, TARGET> asRequired(
                 ErrorMessageProvider errorMessageProvider);
 
         @Override
-        public default BeanBindingBuilder<BEAN, TARGET> setRequired(
+        public default BeanBindingBuilder<BEAN, TARGET> asRequired(
                 String errorMessage) {
-            return (BeanBindingBuilder<BEAN, TARGET>) BindingBuilder.super.setRequired(
+            return (BeanBindingBuilder<BEAN, TARGET>) BindingBuilder.super.asRequired(
                     errorMessage);
         }
 
@@ -222,9 +222,9 @@ public BeanBindingBuilder<BEAN, TARGET> withValidationStatusHandler(
         }
 
         @Override
-        public BeanBindingBuilder<BEAN, TARGET> setRequired(
+        public BeanBindingBuilder<BEAN, TARGET> asRequired(
                 ErrorMessageProvider errorMessageProvider) {
-            return (BeanBindingBuilder<BEAN, TARGET>) super.setRequired(
+            return (BeanBindingBuilder<BEAN, TARGET>) super.asRequired(
                     errorMessageProvider);
         }
 

diff --git a/server/src/main/java/com/vaadin/data/Binder.java b/server/src/main/java/com/vaadin/data/Binder.java
@@ -445,21 +445,21 @@ public BindingBuilder<BEAN, TARGET> withValidationStatusHandler(
          * <li>the field value is validated for not being empty*</li>
          * </ol>
          * For localizing the error message, use
-         * {@link #setRequired(SerializableFunction)}.
+         * {@link #asRequired(ErrorMessageProvider)}.
          * <p>
          * *Value not being the equal to what {@link HasValue#getEmptyValue()}
          * returns.
          *
-         * @see #setRequired(SerializableFunction)
+         * @see #asRequired(ErrorMessageProvider)
          * @see HasValue#setRequiredIndicatorVisible(boolean)
          * @see HasValue#isEmpty()
          * @param errorMessage
          *            the error message to show for the invalid value
          * @return this binding, for chaining
          */
-        public default BindingBuilder<BEAN, TARGET> setRequired(
+        public default BindingBuilder<BEAN, TARGET> asRequired(
                 String errorMessage) {
-            return setRequired(context -> errorMessage);
+            return asRequired(context -> errorMessage);
         }
 
         /**
@@ -477,7 +477,7 @@ public default BindingBuilder<BEAN, TARGET> setRequired(
          *            the provider for localized validation error message
          * @return this binding, for chaining
          */
-        public BindingBuilder<BEAN, TARGET> setRequired(
+        public BindingBuilder<BEAN, TARGET> asRequired(
                 ErrorMessageProvider errorMessageProvider);
     }
 
@@ -587,7 +587,7 @@ public BindingBuilder<BEAN, TARGET> withValidationStatusHandler(
         }
 
         @Override
-        public BindingBuilder<BEAN, TARGET> setRequired(
+        public BindingBuilder<BEAN, TARGET> asRequired(
                 ErrorMessageProvider errorMessageProvider) {
             checkUnbound();
             field.setRequiredIndicatorVisible(true);

diff --git a/server/src/test/java/com/vaadin/data/BinderTest.java b/server/src/test/java/com/vaadin/data/BinderTest.java
@@ -334,7 +334,7 @@ public void setRequired_withErrorMessage_fieldGetsRequiredIndicatorAndValidator(
         BindingBuilder<Person, String> binding = binder.forField(textField);
         Assert.assertFalse(textField.isRequiredIndicatorVisible());
 
-        binding.setRequired("foobar");
+        binding.asRequired("foobar");
         Assert.assertTrue(textField.isRequiredIndicatorVisible());
 
         binding.bind(Person::getFirstName, Person::setFirstName);
@@ -361,7 +361,7 @@ public void setRequired_withErrorMessageProvider_fieldGetsRequiredIndicatorAndVa
         Assert.assertFalse(textField.isRequiredIndicatorVisible());
         AtomicInteger invokes = new AtomicInteger();
 
-        binding.setRequired(context -> {
+        binding.asRequired(context -> {
             invokes.incrementAndGet();
             Assert.assertSame(Locale.CANADA, context.getLocale().get());
             return "foobar";

diff --git a/server/src/test/java/com/vaadin/data/validator/NotEmptyValidator.java b/server/src/test/java/com/vaadin/data/validator/NotEmptyValidator.java
@@ -33,13 +33,14 @@
  * This validator can be suitable for fields that have been marked as required
  * with {@link HasValue#setRequiredIndicatorVisible(boolean)}.
  * <p>
- * Note that {@link BindingBuilder#setRequired(com.vaadin.data.ErrorMessageProvider)}
+ * Note that
- * does almost the same thing, but verifies against the value NOT being equal to
+ * {@link BindingBuilder#asRequired(com.vaadin.data.ErrorMessageProvider)} does
- * what {@link HasValue#getEmptyValue()} returns and sets the required indicator
+ * almost the same thing, but verifies against the value NOT being equal to what
+ * {@link HasValue#getEmptyValue()} returns and sets the required indicator
  * visible with {@link HasValue#setRequiredIndicatorVisible(boolean)}.
  *
  * @see HasValue#setRequiredIndicatorVisible(boolean)
- * @see BindingBuilder#setRequired(com.vaadin.data.ErrorMessageProvider)
+ * @see BindingBuilder#asRequired(com.vaadin.data.ErrorMessageProvider)
  * @author Vaadin Ltd
  * @since 8.0
  *