This is an automated email from the ASF dual-hosted git repository.
garydgregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-validator.git
The following commit(s) were added to refs/heads/master by this push:
new cc673088 Javadoc
cc673088 is described below
commit cc673088916af548fef8758fe283b99c525c4608
Author: Gary Gregory <[email protected]>
AuthorDate: Fri Jun 5 08:43:31 2026 -0400
Javadoc
---
.../java/org/apache/commons/validator/Arg.java | 2 -
.../apache/commons/validator/DateValidator.java | 14 ++--
.../apache/commons/validator/EmailValidator.java | 4 +-
.../java/org/apache/commons/validator/Form.java | 2 -
.../apache/commons/validator/FormSetFactory.java | 8 +--
.../apache/commons/validator/GenericValidator.java | 80 +++++++++++-----------
.../apache/commons/validator/ISBNValidator.java | 3 +-
.../org/apache/commons/validator/UrlValidator.java | 4 +-
.../apache/commons/validator/ValidatorAction.java | 5 +-
.../commons/validator/ValidatorResources.java | 18 +++--
10 files changed, 68 insertions(+), 72 deletions(-)
diff --git a/src/main/java/org/apache/commons/validator/Arg.java
b/src/main/java/org/apache/commons/validator/Arg.java
index 9548787e..787b995b 100644
--- a/src/main/java/org/apache/commons/validator/Arg.java
+++ b/src/main/java/org/apache/commons/validator/Arg.java
@@ -20,7 +20,6 @@ import java.io.Serializable;
import java.text.MessageFormat;
/**
- * <p>
* A default argument or an argument for a
* specific validator definition (ex: required)
* can be stored to pass into a message as parameters. This can be used in a
@@ -31,7 +30,6 @@ import java.text.MessageFormat;
* is a value to be retrieved from a locale sensitive
* message retrieval system like {@code java.util.PropertyResourceBundle}.
* The resource field defaults to 'true'.
- * </p>
* <p>Instances of this class are configured with an <arg> xml
element.</p>
*/
//TODO mutable non-private fields
diff --git a/src/main/java/org/apache/commons/validator/DateValidator.java
b/src/main/java/org/apache/commons/validator/DateValidator.java
index e9af92fa..8d2cafd9 100644
--- a/src/main/java/org/apache/commons/validator/DateValidator.java
+++ b/src/main/java/org/apache/commons/validator/DateValidator.java
@@ -22,7 +22,7 @@ import java.text.SimpleDateFormat;
import java.util.Locale;
/**
- * <p>Perform date validations.</p>
+ * Perform date validations.
* <p>
* This class is a Singleton; you can retrieve the instance via the
* getInstance() method.
@@ -56,9 +56,9 @@ public class DateValidator {
}
/**
- * <p>Checks if the field is a valid date. The {@link Locale} is
- * used with {@link DateFormat}. The setLenient method
- * is set to {@code false} for all.</p>
+ * Checks if the field is a valid date. The {@link Locale} is
+ * used with {@link DateFormat}. The setLenient method
+ * is set to {@code false} for all.
*
* @param value The value validation is being performed on.
* @param locale The locale to use for the date format, defaults to the
default
@@ -85,11 +85,11 @@ public class DateValidator {
}
/**
- * <p>Checks if the field is a valid date. The pattern is used with
- * {@link SimpleDateFormat}. If strict is true, then the
+ * Checks if the field is a valid date. The pattern is used with
+ * {@link SimpleDateFormat}. If strict is true, then the
* length will be checked so '2/12/1999' will not pass validation with
* the format 'MM/dd/yyyy' because the month isn't two digits.
- * The setLenient method is set to {@code false} for all.</p>
+ * The setLenient method is set to {@code false} for all.
*
* @param value The value validation is being performed on.
* @param datePattern The pattern passed to {@link SimpleDateFormat}.
diff --git a/src/main/java/org/apache/commons/validator/EmailValidator.java
b/src/main/java/org/apache/commons/validator/EmailValidator.java
index d949d49f..1c6e382c 100644
--- a/src/main/java/org/apache/commons/validator/EmailValidator.java
+++ b/src/main/java/org/apache/commons/validator/EmailValidator.java
@@ -22,7 +22,7 @@ import java.util.regex.Pattern;
import org.apache.commons.validator.routines.InetAddressValidator;
/**
- * <p>Perform email validations.</p>
+ * Perform email validations.
* <p>
* This class is a Singleton; you can retrieve the instance via the
getInstance() method.
* </p>
@@ -79,7 +79,7 @@ public class EmailValidator {
}
/**
- * <p>Checks if a field has a valid e-mail address.</p>
+ * Checks if a field has a valid e-mail address.
*
* @param email The value validation is being performed on. A {@code null}
* value is considered invalid.
diff --git a/src/main/java/org/apache/commons/validator/Form.java
b/src/main/java/org/apache/commons/validator/Form.java
index 10933d95..b3849295 100644
--- a/src/main/java/org/apache/commons/validator/Form.java
+++ b/src/main/java/org/apache/commons/validator/Form.java
@@ -26,11 +26,9 @@ import java.util.Map;
import org.apache.commons.collections.FastHashMap; // DEPRECATED
/**
- * <p>
* This contains a set of validation rules for a form/JavaBean. The information
* is contained in a list of {@code Field} objects. Instances of this class
* are configured with a <form> xml element.
- * </p>
* <p>
* The use of FastHashMap is deprecated and will be replaced in a future
* release.
diff --git a/src/main/java/org/apache/commons/validator/FormSetFactory.java
b/src/main/java/org/apache/commons/validator/FormSetFactory.java
index 3c993f88..36493862 100644
--- a/src/main/java/org/apache/commons/validator/FormSetFactory.java
+++ b/src/main/java/org/apache/commons/validator/FormSetFactory.java
@@ -39,8 +39,8 @@ public class FormSetFactory extends
AbstractObjectCreationFactory {
}
/**
- * <p>Create or retrieve a {@code FormSet} based on the language, country
- * and variant.</p>
+ * Create or retrieve a {@code FormSet} based on the language, country
+ * and variant.
*
* @param resources The validator resources.
* @param language The locale's language.
@@ -81,8 +81,8 @@ public class FormSetFactory extends
AbstractObjectCreationFactory {
}
/**
- * <p>Create or retrieve a {@code FormSet} for the specified
- * attributes.</p>
+ * Create or retrieve a {@code FormSet} for the specified
+ * attributes.
*
* @param attributes The sax attributes for the formset element.
* @return The FormSet for a locale.
diff --git a/src/main/java/org/apache/commons/validator/GenericValidator.java
b/src/main/java/org/apache/commons/validator/GenericValidator.java
index d2ac1194..cdc853b5 100644
--- a/src/main/java/org/apache/commons/validator/GenericValidator.java
+++ b/src/main/java/org/apache/commons/validator/GenericValidator.java
@@ -57,8 +57,8 @@ public class GenericValidator implements Serializable {
}
/**
- * <p>Checks if the field isn't null and length of the field is greater
- * than zero not including whitespace.</p>
+ * Checks if the field isn't null and length of the field is greater
+ * than zero not including whitespace.
*
* @param value The value validation is being performed on.
* @return true if blank or null.
@@ -69,7 +69,7 @@ public class GenericValidator implements Serializable {
}
/**
- * <p>Checks if the value can safely be converted to a byte primitive.</p>
+ * Checks if the value can safely be converted to a byte primitive.
*
* @param value The value validation is being performed on.
* @return true if the value can be converted to a Byte.
@@ -89,9 +89,9 @@ public class GenericValidator implements Serializable {
}
/**
- * <p>Checks if the field is a valid date. The {@link Locale} is
+ * Checks if the field is a valid date. The {@link Locale} is
* used with {@link DateFormat}. The setLenient method
- * is set to {@code false} for all.</p>
+ * is set to {@code false} for all.
*
* @param value The value validation is being performed on.
* @param locale The locale to use for the date format, defaults to the
@@ -103,11 +103,11 @@ public class GenericValidator implements Serializable {
}
/**
- * <p>Checks if the field is a valid date. The pattern is used with
+ * Checks if the field is a valid date. The pattern is used with
* {@link SimpleDateFormat}. If strict is true, then the
* length will be checked so '2/12/1999' will not pass validation with
* the format 'MM/dd/yyyy' because the month isn't two digits.
- * The setLenient method is set to {@code false} for all.</p>
+ * The setLenient method is set to {@code false} for all.
*
* @param value The value validation is being performed on.
* @param datePattern The pattern passed to {@link SimpleDateFormat}.
@@ -120,7 +120,7 @@ public class GenericValidator implements Serializable {
}
/**
- * <p>Checks if the value can safely be converted to a double
primitive.</p>
+ * Checks if the value can safely be converted to a double primitive.
*
* @param value The value validation is being performed on.
* @return true if the value can be converted to a Double.
@@ -130,7 +130,7 @@ public class GenericValidator implements Serializable {
}
/**
- * <p>Checks if a field has a valid e-mail address.</p>
+ * Checks if a field has a valid e-mail address.
*
* @param value The value validation is being performed on.
* @return true if the value is valid Email Address.
@@ -140,7 +140,7 @@ public class GenericValidator implements Serializable {
}
/**
- * <p>Checks if the value can safely be converted to a float primitive.</p>
+ * Checks if the value can safely be converted to a float primitive.
*
* @param value The value validation is being performed on.
* @return true if the value can be converted to a Float.
@@ -150,8 +150,8 @@ public class GenericValidator implements Serializable {
}
/**
- * <p>Checks if a value is within a range (min & max specified
- * in the vars attribute).</p>
+ * Checks if a value is within a range (min & max specified
+ * in the vars attribute).
*
* @param value The value validation is being performed on.
* @param min The minimum value of the range.
@@ -163,8 +163,8 @@ public class GenericValidator implements Serializable {
}
/**
- * <p>Checks if a value is within a range (min & max specified
- * in the vars attribute).</p>
+ * Checks if a value is within a range (min & max specified
+ * in the vars attribute).
*
* @param value The value validation is being performed on.
* @param min The minimum value of the range.
@@ -176,8 +176,8 @@ public class GenericValidator implements Serializable {
}
/**
- * <p>Checks if a value is within a range (min & max specified
- * in the vars attribute).</p>
+ * Checks if a value is within a range (min & max specified
+ * in the vars attribute).
*
* @param value The value validation is being performed on.
* @param min The minimum value of the range.
@@ -189,8 +189,8 @@ public class GenericValidator implements Serializable {
}
/**
- * <p>Checks if a value is within a range (min & max specified
- * in the vars attribute).</p>
+ * Checks if a value is within a range (min & max specified
+ * in the vars attribute).
*
* @param value The value validation is being performed on.
* @param min The minimum value of the range.
@@ -202,8 +202,8 @@ public class GenericValidator implements Serializable {
}
/**
- * <p>Checks if a value is within a range (min & max specified
- * in the vars attribute).</p>
+ * Checks if a value is within a range (min & max specified
+ * in the vars attribute).
*
* @param value The value validation is being performed on.
* @param min The minimum value of the range.
@@ -215,8 +215,8 @@ public class GenericValidator implements Serializable {
}
/**
- * <p>Checks if a value is within a range (min & max specified
- * in the vars attribute).</p>
+ * Checks if a value is within a range (min & max specified
+ * in the vars attribute).
*
* @param value The value validation is being performed on.
* @param min The minimum value of the range.
@@ -228,7 +228,7 @@ public class GenericValidator implements Serializable {
}
/**
- * <p>Checks if the value can safely be converted to an int primitive.</p>
+ * Checks if the value can safely be converted to an int primitive.
*
* @param value The value validation is being performed on.
* @return true if the value can be converted to an Integer.
@@ -238,7 +238,7 @@ public class GenericValidator implements Serializable {
}
/**
- * <p>Checks if the value can safely be converted to a long primitive.</p>
+ * Checks if the value can safely be converted to a long primitive.
*
* @param value The value validation is being performed on.
* @return true if the value can be converted to a Long.
@@ -248,7 +248,7 @@ public class GenericValidator implements Serializable {
}
/**
- * <p>Checks if the value can safely be converted to a short primitive.</p>
+ * Checks if the value can safely be converted to a short primitive.
*
* @param value The value validation is being performed on.
* @return true if the value can be converted to a Short.
@@ -258,9 +258,11 @@ public class GenericValidator implements Serializable {
}
/**
- * <p>Checks if a field is a valid URL address.</p>
+ * Checks if a field is a valid URL address.
+ * <p>
* If you need to modify what is considered valid then
* consider using the UrlValidator directly.
+ * </p>
*
* @param value The value validation is being performed on.
* @return true if the value is valid Url.
@@ -270,7 +272,7 @@ public class GenericValidator implements Serializable {
}
/**
- * <p>Checks if the value matches the regular expression.</p>
+ * Checks if the value matches the regular expression.
*
* @param value The value validation is being performed on.
* @param regexp The regular expression.
@@ -285,7 +287,7 @@ public class GenericValidator implements Serializable {
}
/**
- * <p>Checks if the value's length is less than or equal to the max.</p>
+ * Checks if the value's length is less than or equal to the max.
*
* @param value The value validation is being performed on.
* @param max The maximum length.
@@ -296,7 +298,7 @@ public class GenericValidator implements Serializable {
}
/**
- * <p>Checks if the value's adjusted length is less than or equal to the
max.</p>
+ * Checks if the value's adjusted length is less than or equal to the max.
*
* @param value The value validation is being performed on.
* @param max The maximum length.
@@ -309,7 +311,7 @@ public class GenericValidator implements Serializable {
}
/**
- * <p>Checks if the value is less than or equal to the max.</p>
+ * Checks if the value is less than or equal to the max.
*
* @param value The value validation is being performed on.
* @param max The maximum numeric value.
@@ -320,7 +322,7 @@ public class GenericValidator implements Serializable {
}
/**
- * <p>Checks if the value is less than or equal to the max.</p>
+ * Checks if the value is less than or equal to the max.
*
* @param value The value validation is being performed on.
* @param max The maximum numeric value.
@@ -331,7 +333,7 @@ public class GenericValidator implements Serializable {
}
/**
- * <p>Checks if the value is less than or equal to the max.</p>
+ * Checks if the value is less than or equal to the max.
*
* @param value The value validation is being performed on.
* @param max The maximum numeric value.
@@ -344,7 +346,7 @@ public class GenericValidator implements Serializable {
// See https://issues.apache.org/bugzilla/show_bug.cgi?id=29015 regarding
the "value" methods.
/**
- * <p>Checks if the value is less than or equal to the max.</p>
+ * Checks if the value is less than or equal to the max.
*
* @param value The value validation is being performed on.
* @param max The maximum numeric value.
@@ -355,7 +357,7 @@ public class GenericValidator implements Serializable {
}
/**
- * <p>Checks if the value's length is greater than or equal to the min.</p>
+ * Checks if the value's length is greater than or equal to the min.
*
* @param value The value validation is being performed on.
* @param min The minimum length.
@@ -366,7 +368,7 @@ public class GenericValidator implements Serializable {
}
/**
- * <p>Checks if the value's adjusted length is greater than or equal to
the min.</p>
+ * Checks if the value's adjusted length is greater than or equal to the
min.
*
* @param value The value validation is being performed on.
* @param min The minimum length.
@@ -379,7 +381,7 @@ public class GenericValidator implements Serializable {
}
/**
- * <p>Checks if the value is greater than or equal to the min.</p>
+ * Checks if the value is greater than or equal to the min.
*
* @param value The value validation is being performed on.
* @param min The minimum numeric value.
@@ -390,7 +392,7 @@ public class GenericValidator implements Serializable {
}
/**
- * <p>Checks if the value is greater than or equal to the min.</p>
+ * Checks if the value is greater than or equal to the min.
*
* @param value The value validation is being performed on.
* @param min The minimum numeric value.
@@ -401,7 +403,7 @@ public class GenericValidator implements Serializable {
}
/**
- * <p>Checks if the value is greater than or equal to the min.</p>
+ * Checks if the value is greater than or equal to the min.
*
* @param value The value validation is being performed on.
* @param min The minimum numeric value.
@@ -412,7 +414,7 @@ public class GenericValidator implements Serializable {
}
/**
- * <p>Checks if the value is greater than or equal to the min.</p>
+ * Checks if the value is greater than or equal to the min.
*
* @param value The value validation is being performed on.
* @param min The minimum numeric value.
diff --git a/src/main/java/org/apache/commons/validator/ISBNValidator.java
b/src/main/java/org/apache/commons/validator/ISBNValidator.java
index fd124659..4adaa2d2 100644
--- a/src/main/java/org/apache/commons/validator/ISBNValidator.java
+++ b/src/main/java/org/apache/commons/validator/ISBNValidator.java
@@ -21,9 +21,10 @@ package org.apache.commons.validator;
* Based on this
* <a
href="https://www.isbn.org/standards/home/isbn/international/html/usm4.htm";>
* algorithm</a>
- *
+ * <p>
* <strong>NOTE:</strong> This has been replaced by the new
* {@link org.apache.commons.validator.routines.ISBNValidator}.
+ * </p>
*
* @since 1.2.0
* @deprecated Use the new ISBNValidator in the routines package
diff --git a/src/main/java/org/apache/commons/validator/UrlValidator.java
b/src/main/java/org/apache/commons/validator/UrlValidator.java
index 9a1907d1..19d596c9 100644
--- a/src/main/java/org/apache/commons/validator/UrlValidator.java
+++ b/src/main/java/org/apache/commons/validator/UrlValidator.java
@@ -27,7 +27,7 @@ import
org.apache.commons.validator.routines.InetAddressValidator;
import org.apache.commons.validator.util.Flags;
/**
- * <p>Validates URLs.</p>
+ * Validates URLs.
* Behaviour of validation is modified by passing in options:
* <ul>
* <li>ALLOW_2_SLASHES - [FALSE] Allows double '/' characters in the path
@@ -260,7 +260,7 @@ public class UrlValidator implements Serializable {
}
/**
- * <p>Checks if a field has a valid URL address.</p>
+ * Checks if a field has a valid URL address.
*
* @param value The value validation is being performed on. A {@code null}
* value is considered invalid.
diff --git a/src/main/java/org/apache/commons/validator/ValidatorAction.java
b/src/main/java/org/apache/commons/validator/ValidatorAction.java
index 287034dd..cbb7ae9b 100644
--- a/src/main/java/org/apache/commons/validator/ValidatorAction.java
+++ b/src/main/java/org/apache/commons/validator/ValidatorAction.java
@@ -38,8 +38,9 @@ import org.apache.commons.validator.util.ValidatorUtils;
/**
* Contains the information to dynamically create and run a validation method.
This is the class representation of a pluggable validator that can be defined in
* an xml file with the <validator> element.
- *
+ * <p>
* <strong>Note</strong>: The validation method is assumed to be thread safe.
+ * </p>
*/
public class ValidatorAction implements Serializable {
@@ -76,10 +77,8 @@ public class ValidatorAction implements Serializable {
private transient Method validationMethod;
/**
- * <p>
* The method signature of the validation method. This should be a
comma-delimited list of the full class names of each parameter in the correct
order that
* the method takes.
- * </p>
* <p>
* Note: {@link Object} is reserved for the JavaBean that is being
validated. The {@code ValidatorAction} and {@code Field} that
* are associated with a field's validation will automatically be
populated if they are specified in the method signature.
diff --git a/src/main/java/org/apache/commons/validator/ValidatorResources.java
b/src/main/java/org/apache/commons/validator/ValidatorResources.java
index cf869ed4..eb9183b3 100644
--- a/src/main/java/org/apache/commons/validator/ValidatorResources.java
+++ b/src/main/java/org/apache/commons/validator/ValidatorResources.java
@@ -34,11 +34,9 @@ import org.xml.sax.Attributes;
import org.xml.sax.SAXException;
/**
- * <p>
* General purpose class for storing {@code FormSet} objects based
* on their associated {@link Locale}. Instances of this class are usually
* configured through a validation.xml file that is parsed in a constructor.
- * </p>
*
* <p><strong>Note</strong> - Classes that extend this class
* must be Serializable so that instances may be used in distributable
@@ -380,9 +378,9 @@ public class ValidatorResources implements Serializable {
}
/**
- * <p>Gets a {@code Form} based on the name of the form and the
+ * Gets a {@code Form} based on the name of the form and the
* {@link Locale} that most closely matches the {@link Locale}
- * passed in. The order of {@link Locale} matching is:</p>
+ * passed in. The order of {@link Locale} matching is:
* <ol>
* <li>language + country + variant</li>
* <li>language + country</li>
@@ -401,9 +399,9 @@ public class ValidatorResources implements Serializable {
}
/**
- * <p>Gets a {@code Form} based on the name of the form and the
+ * Gets a {@code Form} based on the name of the form and the
* {@link Locale} that most closely matches the {@link Locale}
- * passed in. The order of {@link Locale} matching is:</p>
+ * passed in. The order of {@link Locale} matching is:
* <ol>
* <li>language + country + variant</li>
* <li>language + country</li>
@@ -473,8 +471,8 @@ public class ValidatorResources implements Serializable {
}
/**
- * <p>Gets a {@code FormSet} based on the language, country
- * and variant.</p>
+ * Gets a {@code FormSet} based on the language, country
+ * and variant.
*
* @param language The locale's language.
* @param country The locale's country.
@@ -616,9 +614,9 @@ public class ValidatorResources implements Serializable {
}
/**
- * <p>Process the {@code Form} objects. This clones the {@code Field}s
+ * Process the {@code Form} objects. This clones the {@code Field}s
* that don't exist in a {@code FormSet} compared to its parent
- * {@code FormSet}.</p>
+ * {@code FormSet}.
*/
private void processForms() {
if (defaultFormSet == null) { // it isn't mandatory to have a
