You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@wicket.apache.org by pa...@apache.org on 2013/10/28 09:16:32 UTC
[16/47] git commit: WICKET-5341 JavaDoc for IFormValidator
WICKET-5341 JavaDoc for IFormValidator
Improve Javadoc to explain how to report an error.
Remove an old/obsolete TODO
Project: http://git-wip-us.apache.org/repos/asf/wicket/repo
Commit: http://git-wip-us.apache.org/repos/asf/wicket/commit/1c681337
Tree: http://git-wip-us.apache.org/repos/asf/wicket/tree/1c681337
Diff: http://git-wip-us.apache.org/repos/asf/wicket/diff/1c681337
Branch: refs/heads/wicket-4997
Commit: 1c681337e7a3995df4cdb7e39f4e210909859fcb
Parents: e5c9b21
Author: Martin Tzvetanov Grigorov <mg...@apache.org>
Authored: Fri Sep 6 11:13:35 2013 +0300
Committer: Martin Tzvetanov Grigorov <mg...@apache.org>
Committed: Fri Sep 6 11:13:35 2013 +0300
----------------------------------------------------------------------
.../form/validation/AbstractFormValidator.java | 19 +++++-----------
.../form/validation/EqualInputValidator.java | 23 +++++---------------
.../html/form/validation/IFormValidator.java | 15 ++++++++-----
3 files changed, 20 insertions(+), 37 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/wicket/blob/1c681337/wicket-core/src/main/java/org/apache/wicket/markup/html/form/validation/AbstractFormValidator.java
----------------------------------------------------------------------
diff --git a/wicket-core/src/main/java/org/apache/wicket/markup/html/form/validation/AbstractFormValidator.java b/wicket-core/src/main/java/org/apache/wicket/markup/html/form/validation/AbstractFormValidator.java
index 1c15f61..a103252 100644
--- a/wicket-core/src/main/java/org/apache/wicket/markup/html/form/validation/AbstractFormValidator.java
+++ b/wicket-core/src/main/java/org/apache/wicket/markup/html/form/validation/AbstractFormValidator.java
@@ -22,6 +22,7 @@ import java.util.Map;
import org.apache.wicket.behavior.Behavior;
import org.apache.wicket.markup.html.form.FormComponent;
import org.apache.wicket.model.IModel;
+import org.apache.wicket.util.lang.Args;
import org.apache.wicket.util.lang.Classes;
import org.apache.wicket.validation.ValidationError;
@@ -95,19 +96,9 @@ public abstract class AbstractFormValidator extends Behavior implements IFormVal
*/
public void error(FormComponent<?> fc, final String resourceKey, Map<String, Object> vars)
{
- if (fc == null)
- {
- throw new IllegalArgumentException("Argument [[fc]] cannot be null");
- }
- if (vars == null)
- {
- throw new IllegalArgumentException("Argument [[vars]] cannot be null");
- }
- if (resourceKey == null)
- {
- throw new IllegalArgumentException("Argument [[resourceKey]] cannot be null");
- }
-
+ Args.notNull(fc, "fc");
+ Args.notNull(vars, "vars");
+ Args.notNull(resourceKey, "resourceKey");
ValidationError error = new ValidationError().addKey(resourceKey);
final String defaultKey = Classes.simpleName(getClass());
@@ -176,4 +167,4 @@ public abstract class AbstractFormValidator extends Behavior implements IFormVal
{
return Classes.simpleName(getClass());
}
-}
\ No newline at end of file
+}
http://git-wip-us.apache.org/repos/asf/wicket/blob/1c681337/wicket-core/src/main/java/org/apache/wicket/markup/html/form/validation/EqualInputValidator.java
----------------------------------------------------------------------
diff --git a/wicket-core/src/main/java/org/apache/wicket/markup/html/form/validation/EqualInputValidator.java b/wicket-core/src/main/java/org/apache/wicket/markup/html/form/validation/EqualInputValidator.java
index ebb7ca6..8b1d72a 100644
--- a/wicket-core/src/main/java/org/apache/wicket/markup/html/form/validation/EqualInputValidator.java
+++ b/wicket-core/src/main/java/org/apache/wicket/markup/html/form/validation/EqualInputValidator.java
@@ -18,6 +18,7 @@ package org.apache.wicket.markup.html.form.validation;
import org.apache.wicket.markup.html.form.Form;
import org.apache.wicket.markup.html.form.FormComponent;
+import org.apache.wicket.util.lang.Args;
import org.apache.wicket.util.lang.Objects;
/**
@@ -34,9 +35,6 @@ import org.apache.wicket.util.lang.Objects;
*/
public class EqualInputValidator extends AbstractFormValidator
{
- /**
- *
- */
private static final long serialVersionUID = 1L;
/** form components to be checked. */
@@ -52,29 +50,18 @@ public class EqualInputValidator extends AbstractFormValidator
*/
public EqualInputValidator(FormComponent<?> formComponent1, FormComponent<?> formComponent2)
{
- if (formComponent1 == null)
- {
- throw new IllegalArgumentException("argument formComponent1 cannot be null");
- }
- if (formComponent2 == null)
- {
- throw new IllegalArgumentException("argument formComponent2 cannot be null");
- }
+ Args.notNull(formComponent1, "formComponent1");
+ Args.notNull(formComponent2, "formComponent2");
+
components = new FormComponent[] { formComponent1, formComponent2 };
}
- /**
- * @see org.apache.wicket.markup.html.form.validation.IFormValidator#getDependentFormComponents()
- */
@Override
public FormComponent<?>[] getDependentFormComponents()
{
return components;
}
- /**
- * @see org.apache.wicket.markup.html.form.validation.IFormValidator#validate(org.apache.wicket.markup.html.form.Form)
- */
@Override
public void validate(Form<?> form)
{
@@ -89,4 +76,4 @@ public class EqualInputValidator extends AbstractFormValidator
}
}
-}
\ No newline at end of file
+}
http://git-wip-us.apache.org/repos/asf/wicket/blob/1c681337/wicket-core/src/main/java/org/apache/wicket/markup/html/form/validation/IFormValidator.java
----------------------------------------------------------------------
diff --git a/wicket-core/src/main/java/org/apache/wicket/markup/html/form/validation/IFormValidator.java b/wicket-core/src/main/java/org/apache/wicket/markup/html/form/validation/IFormValidator.java
index 3e35c55..661fa1d 100644
--- a/wicket-core/src/main/java/org/apache/wicket/markup/html/form/validation/IFormValidator.java
+++ b/wicket-core/src/main/java/org/apache/wicket/markup/html/form/validation/IFormValidator.java
@@ -26,10 +26,9 @@ import org.apache.wicket.util.io.IClusterable;
* {@link IFormValidator#getDependentFormComponents()} have been successfully validated before this
* validator runs.
*
- * TODO post 1.3: remove validate(form) *make IFormValidator extends IValidator where IValidatable's
- * value is form.modelobject and error reports on form - that way IBehaviorProvider can extend
- * IValidator
- *
+ *
+ * @see AbstractFormValidator
+ * @see org.apache.wicket.validation.IValidator
* @author Igor Vaynberg (ivaynberg)
*/
public interface IFormValidator extends IClusterable
@@ -42,9 +41,15 @@ public interface IFormValidator extends IClusterable
/**
* This method is ran if all components returned by
* {@link IFormValidator#getDependentFormComponents()} are valid.
+ *
+ * <p>
+ * To report validation error use
+ * {@link FormComponent#error(org.apache.wicket.validation.IValidationError)} by using any of
+ * the dependent form components or extend from AbstractFormValidator and use its
+ * {@link AbstractFormValidator#error(FormComponent, String, java.util.Map)} method.
*
* @param form
* form this validator is added to
*/
void validate(Form<?> form);
-}
\ No newline at end of file
+}