summaryrefslogtreecommitdiffstats
path: root/server/src/com/vaadin/data/Validatable.java
diff options
context:
space:
mode:
authorArtur Signell <artur@vaadin.com>2012-08-13 18:34:33 +0300
committerArtur Signell <artur@vaadin.com>2012-08-13 19:18:33 +0300
commite85d933b25cc3c5cc85eb7eb4b13b950fd8e1569 (patch)
tree9ab6f13f7188cab44bbd979b1cf620f15328a03f /server/src/com/vaadin/data/Validatable.java
parent14dd4d0b28c76eb994b181a4570f3adec53342e6 (diff)
downloadvaadin-framework-e85d933b25cc3c5cc85eb7eb4b13b950fd8e1569.tar.gz
vaadin-framework-e85d933b25cc3c5cc85eb7eb4b13b950fd8e1569.zip
Moved server files to a server src folder (#9299)
Diffstat (limited to 'server/src/com/vaadin/data/Validatable.java')
-rw-r--r--server/src/com/vaadin/data/Validatable.java110
1 files changed, 110 insertions, 0 deletions
diff --git a/server/src/com/vaadin/data/Validatable.java b/server/src/com/vaadin/data/Validatable.java
new file mode 100644
index 0000000000..4a7a0fda10
--- /dev/null
+++ b/server/src/com/vaadin/data/Validatable.java
@@ -0,0 +1,110 @@
+/*
+@VaadinApache2LicenseForJavaFiles@
+ */
+
+package com.vaadin.data;
+
+import java.io.Serializable;
+import java.util.Collection;
+
+/**
+ * <p>
+ * Interface for validatable objects. Defines methods to verify if the object's
+ * value is valid or not, and to add, remove and list registered validators of
+ * the object.
+ * </p>
+ *
+ * @author Vaadin Ltd.
+ * @version
+ * @VERSION@
+ * @since 3.0
+ * @see com.vaadin.data.Validator
+ */
+public interface Validatable extends Serializable {
+
+ /**
+ * <p>
+ * Adds a new validator for this object. The validator's
+ * {@link Validator#validate(Object)} method is activated every time the
+ * object's value needs to be verified, that is, when the {@link #isValid()}
+ * method is called. This usually happens when the object's value changes.
+ * </p>
+ *
+ * @param validator
+ * the new validator
+ */
+ void addValidator(Validator validator);
+
+ /**
+ * <p>
+ * Removes a previously registered validator from the object. The specified
+ * validator is removed from the object and its <code>validate</code> method
+ * is no longer called in {@link #isValid()}.
+ * </p>
+ *
+ * @param validator
+ * the validator to remove
+ */
+ void removeValidator(Validator validator);
+
+ /**
+ * <p>
+ * Lists all validators currently registered for the object. If no
+ * validators are registered, returns <code>null</code>.
+ * </p>
+ *
+ * @return collection of validators or <code>null</code>
+ */
+ public Collection<Validator> getValidators();
+
+ /**
+ * <p>
+ * Tests the current value of the object against all registered validators.
+ * The registered validators are iterated and for each the
+ * {@link Validator#validate(Object)} method is called. If any validator
+ * throws the {@link Validator.InvalidValueException} this method returns
+ * <code>false</code>.
+ * </p>
+ *
+ * @return <code>true</code> if the registered validators concur that the
+ * value is valid, <code>false</code> otherwise
+ */
+ public boolean isValid();
+
+ /**
+ * <p>
+ * Checks the validity of the validatable. If the validatable is valid this
+ * method should do nothing, and if it's not valid, it should throw
+ * <code>Validator.InvalidValueException</code>
+ * </p>
+ *
+ * @throws Validator.InvalidValueException
+ * if the value is not valid
+ */
+ public void validate() throws Validator.InvalidValueException;
+
+ /**
+ * <p>
+ * Checks the validabtable object accept invalid values.The default value is
+ * <code>true</code>.
+ * </p>
+ *
+ */
+ public boolean isInvalidAllowed();
+
+ /**
+ * <p>
+ * Should the validabtable object accept invalid values. Supporting this
+ * configuration possibility is optional. By default invalid values are
+ * allowed.
+ * </p>
+ *
+ * @param invalidValueAllowed
+ *
+ * @throws UnsupportedOperationException
+ * if the setInvalidAllowed is not supported.
+ */
+ public void setInvalidAllowed(boolean invalidValueAllowed)
+ throws UnsupportedOperationException;
+
+}