From: Artur Signell <artur.signell@itmill.com>
Date: Mon, 14 Dec 2009 07:16:54 +0000 (+0000)
Subject: Document empty/required validation behvaior in javadoc (#3787).
X-Git-Tag: 6.7.0.beta1~2173
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=dca90d6e1683973332c31b685679d29eea7ff18f;p=vaadin-framework.git

Document empty/required validation behvaior in javadoc (#3787).

svn changeset:10268/svn branch:6.2
---

diff --git a/src/com/vaadin/ui/AbstractField.java b/src/com/vaadin/ui/AbstractField.java
index 59b9497172..b45e73ab50 100644
--- a/src/com/vaadin/ui/AbstractField.java
+++ b/src/com/vaadin/ui/AbstractField.java
@@ -634,10 +634,13 @@ public abstract class AbstractField extends AbstractComponent implements Field,
     }
 
     /**
-     * Tests the current value against all registered validators.
+     * Tests the current value against registered validators if the field is not
+     * empty. If the field is empty it is considered valid if it is not required
+     * and invalid otherwise. Validators are never checked for empty fields.
      * 
      * @return <code>true</code> if all registered validators claim that the
-     *         current value is valid, <code>false</code> otherwise.
+     *         current value is valid or if the field is empty and not required,
+     *         <code>false</code> otherwise.
      */
     public boolean isValid() {
 
@@ -665,7 +668,8 @@ public abstract class AbstractField extends AbstractComponent implements Field,
 
     /**
      * Checks the validity of the Validatable by validating the field with all
-     * attached validators.
+     * attached validators except when the field is empty. An empty field is
+     * invalid if it is required and valid otherwise.
      * 
      * The "required" validation is a built-in validation feature. If the field
      * is required, but empty, validation will throw an EmptyValueException with