aboutsummaryrefslogtreecommitdiffstats
path: root/server/src/com/vaadin/data/validator/AbstractStringValidator.java
diff options
context:
space:
mode:
Diffstat (limited to 'server/src/com/vaadin/data/validator/AbstractStringValidator.java')
-rw-r--r--server/src/com/vaadin/data/validator/AbstractStringValidator.java42
1 files changed, 42 insertions, 0 deletions
diff --git a/server/src/com/vaadin/data/validator/AbstractStringValidator.java b/server/src/com/vaadin/data/validator/AbstractStringValidator.java
new file mode 100644
index 0000000000..5267cc7b7b
--- /dev/null
+++ b/server/src/com/vaadin/data/validator/AbstractStringValidator.java
@@ -0,0 +1,42 @@
+/*
+@VaadinApache2LicenseForJavaFiles@
+ */
+package com.vaadin.data.validator;
+
+/**
+ * Validator base class for validating strings.
+ * <p>
+ * To include the value that failed validation in the exception message you can
+ * use "{0}" in the error message. This will be replaced with the failed value
+ * (converted to string using {@link #toString()}) or "null" if the value is
+ * null.
+ * </p>
+ *
+ * @author Vaadin Ltd.
+ * @version @VERSION@
+ * @since 5.4
+ */
+@SuppressWarnings("serial")
+public abstract class AbstractStringValidator extends AbstractValidator<String> {
+
+ /**
+ * Constructs a validator for strings.
+ *
+ * <p>
+ * Null and empty string values are always accepted. To reject empty values,
+ * set the field being validated as required.
+ * </p>
+ *
+ * @param errorMessage
+ * the message to be included in an {@link InvalidValueException}
+ * (with "{0}" replaced by the value that failed validation).
+ * */
+ public AbstractStringValidator(String errorMessage) {
+ super(errorMessage);
+ }
+
+ @Override
+ public Class<String> getType() {
+ return String.class;
+ }
+}