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 4098f0c2 Javadoc
4098f0c2 is described below
commit 4098f0c201e161ba3904063e057e6c5810def045
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 11:22:52 2026 -0400
Javadoc
---
.../java/org/apache/commons/validator/Arg.java | 2 +-
.../java/org/apache/commons/validator/Field.java | 4 ++--
.../java/org/apache/commons/validator/Form.java | 2 +-
.../org/apache/commons/validator/Validator.java | 4 ++--
.../commons/validator/ValidatorException.java | 6 ++---
.../routines/AbstractCalendarValidator.java | 4 ++--
.../validator/routines/CalendarValidator.java | 2 +-
.../validator/routines/CreditCardValidator.java | 12 +++++-----
.../commons/validator/routines/DateValidator.java | 2 +-
.../validator/routines/DomainValidator.java | 26 ++++++++++----------
.../commons/validator/routines/IBANValidator.java | 24 +++++++++----------
.../commons/validator/routines/ISSNValidator.java | 2 +-
.../validator/routines/InetAddressValidator.java | 6 ++---
.../commons/validator/routines/TimeValidator.java | 2 +-
.../commons/validator/routines/UrlValidator.java | 6 ++---
.../routines/checkdigit/ModulusTenCheckDigit.java | 6 ++---
.../validator/GenericTypeValidatorImpl.java | 28 +++++++++++-----------
.../commons/validator/GenericValidatorImpl.java | 14 +++++------
.../routines/AbstractCalendarValidatorTest.java | 4 ++--
.../validator/routines/DomainValidatorTest.java | 2 +-
.../validator/routines/TimeValidatorTest.java | 8 +++----
21 files changed, 83 insertions(+), 83 deletions(-)
diff --git a/src/main/java/org/apache/commons/validator/Arg.java
b/src/main/java/org/apache/commons/validator/Arg.java
index cb994311..7d823eb1 100644
--- a/src/main/java/org/apache/commons/validator/Arg.java
+++ b/src/main/java/org/apache/commons/validator/Arg.java
@@ -159,7 +159,7 @@ public class Arg implements Cloneable, Serializable {
/**
* Sets the name of the dependency.
*
- * @param name the name of the dependency.
+ * @param name The name of the dependency.
*/
public void setName(final String name) {
this.name = name;
diff --git a/src/main/java/org/apache/commons/validator/Field.java
b/src/main/java/org/apache/commons/validator/Field.java
index 93be26fb..cffbc20a 100644
--- a/src/main/java/org/apache/commons/validator/Field.java
+++ b/src/main/java/org/apache/commons/validator/Field.java
@@ -768,7 +768,7 @@ public class Field implements Cloneable, Serializable {
* Sets the flag that determines whether client-side scripting should
* be generated for this field.
*
- * @param clientValidation the scripting flag
+ * @param clientValidation The scripting flag
* @see #isClientValidation()
* @since 1.4
*/
@@ -827,7 +827,7 @@ public class Field implements Cloneable, Serializable {
* Sets a unique key for the field. This can be used to change
* the key temporarily to have a unique key for an indexed field.
*
- * @param key a unique key for the field
+ * @param key A unique key for the field
*/
public void setKey(final String key) {
this.key = key;
diff --git a/src/main/java/org/apache/commons/validator/Form.java
b/src/main/java/org/apache/commons/validator/Form.java
index b18807b5..54eeed6b 100644
--- a/src/main/java/org/apache/commons/validator/Form.java
+++ b/src/main/java/org/apache/commons/validator/Form.java
@@ -176,7 +176,7 @@ public class Form implements Serializable {
* not present in this form, include it. {@code depends} has precedence
* in the way the fields are ordered.
*
- * @param depends the form we want to merge
+ * @param depends The form we want to merge
* @since 1.2.0
*/
protected void merge(final Form depends) {
diff --git a/src/main/java/org/apache/commons/validator/Validator.java
b/src/main/java/org/apache/commons/validator/Validator.java
index c8369ee8..02e1c78c 100644
--- a/src/main/java/org/apache/commons/validator/Validator.java
+++ b/src/main/java/org/apache/commons/validator/Validator.java
@@ -364,7 +364,7 @@ public class Validator implements Serializable {
/**
* Sets the form name which is the key to a set of validation rules.
*
- * @param formName the name of the form.
+ * @param formName The name of the form.
*/
public void setFormName(final String formName) {
this.formName = formName;
@@ -389,7 +389,7 @@ public class Validator implements Serializable {
* is less than or equal to this page value, it will be processed.
* </p>
*
- * @param page the page number.
+ * @param page The page number.
*/
public void setPage(final int page) {
this.page = page;
diff --git a/src/main/java/org/apache/commons/validator/ValidatorException.java
b/src/main/java/org/apache/commons/validator/ValidatorException.java
index dccad070..7a5f556d 100644
--- a/src/main/java/org/apache/commons/validator/ValidatorException.java
+++ b/src/main/java/org/apache/commons/validator/ValidatorException.java
@@ -59,8 +59,8 @@ public class ValidatorException extends Exception {
* Note that the detail message associated with {@code cause} is
<em>not</em> automatically incorporated in this exception's detail message.
* </p>
*
- * @param message the detail message (which is saved for later retrieval
by the {@link #getMessage()} method).
- * @param cause the cause (which is saved for later retrieval by the
{@link #getCause()} method). (A {@code null} value is permitted, and indicates
that
+ * @param message The detail message (which is saved for later retrieval
by the {@link #getMessage()} method).
+ * @param cause The cause (which is saved for later retrieval by the
{@link #getCause()} method). (A {@code null} value is permitted, and indicates
that
* the cause is nonexistent or unknown.)
* @since 1.11.0
*/
@@ -73,7 +73,7 @@ public class ValidatorException extends Exception {
* class and detail message of {@code cause}). This constructor is useful
for exceptions that are little more than wrappers for other throwables (for
* example, {@link PrivilegedActionException}).
*
- * @param cause the cause (which is saved for later retrieval by the
{@link #getCause()} method). (A {@code null} value is permitted, and indicates
that the
+ * @param cause The cause (which is saved for later retrieval by the
{@link #getCause()} method). (A {@code null} value is permitted, and indicates
that the
* cause is nonexistent or unknown.)
* @since 1.11.0
*/
diff --git
a/src/main/java/org/apache/commons/validator/routines/AbstractCalendarValidator.java
b/src/main/java/org/apache/commons/validator/routines/AbstractCalendarValidator.java
index 75468905..34be11d0 100644
---
a/src/main/java/org/apache/commons/validator/routines/AbstractCalendarValidator.java
+++
b/src/main/java/org/apache/commons/validator/routines/AbstractCalendarValidator.java
@@ -58,8 +58,8 @@ public abstract class AbstractCalendarValidator extends
AbstractFormatValidator
*
* @param strict {@code true} if strict
* {@code Format} parsing should be used.
- * @param dateStyle the date style to use for Locale validation.
- * @param timeStyle the time style to use for Locale validation.
+ * @param dateStyle The date style to use for Locale validation.
+ * @param timeStyle The time style to use for Locale validation.
*/
public AbstractCalendarValidator(final boolean strict, final int
dateStyle, final int timeStyle) {
super(strict);
diff --git
a/src/main/java/org/apache/commons/validator/routines/CalendarValidator.java
b/src/main/java/org/apache/commons/validator/routines/CalendarValidator.java
index 03ed2f38..37249b39 100644
--- a/src/main/java/org/apache/commons/validator/routines/CalendarValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/CalendarValidator.java
@@ -133,7 +133,7 @@ public class CalendarValidator extends
AbstractCalendarValidator {
*
* @param strict {@code true} if strict
* {@code Format} parsing should be used.
- * @param dateStyle the date style to use for Locale validation.
+ * @param dateStyle The date style to use for Locale validation.
*/
public CalendarValidator(final boolean strict, final int dateStyle) {
super(strict, dateStyle, -1);
diff --git
a/src/main/java/org/apache/commons/validator/routines/CreditCardValidator.java
b/src/main/java/org/apache/commons/validator/routines/CreditCardValidator.java
index ec26d832..170e7e76 100644
---
a/src/main/java/org/apache/commons/validator/routines/CreditCardValidator.java
+++
b/src/main/java/org/apache/commons/validator/routines/CreditCardValidator.java
@@ -104,10 +104,10 @@ public class CreditCardValidator implements Serializable {
* for example, Discover "644" and "65".
* </p>
*
- * @param low the low digits of the IIN range
- * @param high the high digits of the IIN range
- * @param minLen the minimum length of the entire number
- * @param maxLen the maximum length of the entire number
+ * @param low The low digits of the IIN range
+ * @param high The high digits of the IIN range
+ * @param minLen The minimum length of the entire number
+ * @param maxLen The maximum length of the entire number
*/
public CreditCardRange(final String low, final String high, final int
minLen, final int maxLen) {
this.low = low;
@@ -130,8 +130,8 @@ public class CreditCardValidator implements Serializable {
* for example, Discover "644" and "65".
* </p>
*
- * @param low the low digits of the IIN range
- * @param high the high digits of the IIN range
+ * @param low The low digits of the IIN range
+ * @param high The high digits of the IIN range
* @param lengths array of valid lengths
*/
public CreditCardRange(final String low, final String high, final int
[] lengths) {
diff --git
a/src/main/java/org/apache/commons/validator/routines/DateValidator.java
b/src/main/java/org/apache/commons/validator/routines/DateValidator.java
index bb8ee2f1..6e2dda34 100644
--- a/src/main/java/org/apache/commons/validator/routines/DateValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/DateValidator.java
@@ -110,7 +110,7 @@ public class DateValidator extends
AbstractCalendarValidator {
*
* @param strict {@code true} if strict
* {@code Format} parsing should be used.
- * @param dateStyle the date style to use for Locale validation.
+ * @param dateStyle The date style to use for Locale validation.
*/
public DateValidator(final boolean strict, final int dateStyle) {
super(strict, dateStyle, -1);
diff --git
a/src/main/java/org/apache/commons/validator/routines/DomainValidator.java
b/src/main/java/org/apache/commons/validator/routines/DomainValidator.java
index 4971404f..70089579 100644
--- a/src/main/java/org/apache/commons/validator/routines/DomainValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/DomainValidator.java
@@ -1825,8 +1825,8 @@ public class DomainValidator implements Serializable {
/**
* Tests if a sorted array contains the specified key
*
- * @param sortedArray the array to search.
- * @param key the key to find.
+ * @param sortedArray The array to search.
+ * @param key The key to find.
* @return {@code true} if the array contains the key.
*/
private static boolean arrayContains(final String[] sortedArray, final
String key) {
@@ -1875,7 +1875,7 @@ public class DomainValidator implements Serializable {
/**
* Gets a copy of a class level internal array.
*
- * @param table the array type (any of the enum values).
+ * @param table The array type (any of the enum values).
* @return A copy of the array.
* @throws IllegalArgumentException if the table type is unexpected
(should not happen).
* @since 1.5.1
@@ -1937,7 +1937,7 @@ public class DomainValidator implements Serializable {
/**
* Converts potentially Unicode input to punycode. If conversion fails,
returns the original input.
*
- * @param input the string to convert, not null.
+ * @param input The string to convert, not null.
* @return converted input, or original input if conversion fails.
*/
// Needed by UrlValidator
@@ -1986,7 +1986,7 @@ public class DomainValidator implements Serializable {
* To clear an override array, provide an empty array.
* </p>
*
- * @param table the table to update, see {@link ArrayType} Must be one of
the following
+ * @param table The table to update, see {@link ArrayType} Must be one of
the following
* <ul>
* <li>COUNTRY_CODE_MINUS</li>
* <li>COUNTRY_CODE_PLUS</li>
@@ -1995,7 +1995,7 @@ public class DomainValidator implements Serializable {
* <li>LOCAL_MINUS</li>
* <li>LOCAL_PLUS</li>
* </ul>
- * @param tlds the array of TLDs, must not be null.
+ * @param tlds The array of TLDs, must not be null.
* @throws IllegalStateException if the method is called after
getInstance.
* @throws IllegalArgumentException if one of the read-only tables is
requested.
* @since 1.5.0
@@ -2178,7 +2178,7 @@ public class DomainValidator implements Serializable {
/**
* Gets a copy of an instance level internal array.
*
- * @param table the array type (any of the enum values).
+ * @param table The array type (any of the enum values).
* @return A copy of the array.
* @throws IllegalArgumentException if the table type is unexpected, for
example, GENERIC_RO.
* @since 1.7
@@ -2223,7 +2223,7 @@ public class DomainValidator implements Serializable {
/**
* Tests whether the specified {@link String} parses as a valid domain
name with a recognized top-level domain. The parsing is case-insensitive.
*
- * @param domain the parameter to check for domain name syntax.
+ * @param domain The parameter to check for domain name syntax.
* @return true if the parameter is a valid domain name.
*/
public boolean isValid(final String domain) {
@@ -2249,7 +2249,7 @@ public class DomainValidator implements Serializable {
* Tests whether the specified {@link String} matches any IANA-defined
country code top-level domain. Leading dots are ignored if present. The search
is
* case-insensitive.
*
- * @param ccTld the parameter to check for country code TLD status, not
null.
+ * @param ccTld The parameter to check for country code TLD status, not
null.
* @return true if the parameter is a country code TLD.
*/
public boolean isValidCountryCodeTld(final String ccTld) {
@@ -2279,7 +2279,7 @@ public class DomainValidator implements Serializable {
* Tests whether the specified {@link String} matches any IANA-defined
generic top-level domain. Leading dots are ignored if present. The search is
* case-insensitive.
*
- * @param gTld the parameter to check for generic TLD status, not null.
+ * @param gTld The parameter to check for generic TLD status, not null.
* @return true if the parameter is a generic TLD.
*/
public boolean isValidGenericTld(final String gTld) {
@@ -2291,7 +2291,7 @@ public class DomainValidator implements Serializable {
* Tests whether the specified {@link String} matches any IANA-defined
infrastructure top-level domain. Leading dots are ignored if present. The
search is
* case-insensitive.
*
- * @param iTld the parameter to check for infrastructure TLD status, not
null.
+ * @param iTld The parameter to check for infrastructure TLD status, not
null.
* @return true if the parameter is an infrastructure TLD.
*/
public boolean isValidInfrastructureTld(final String iTld) {
@@ -2303,7 +2303,7 @@ public class DomainValidator implements Serializable {
* Tests whether the specified {@link String} matches any widely used
"local" domains (localhost or localdomain). Leading dots are ignored if
present. The
* search is case-insensitive.
*
- * @param lTld the parameter to check for local TLD status, not null.
+ * @param lTld The parameter to check for local TLD status, not null.
* @return true if the parameter is a local TLD.
*/
public boolean isValidLocalTld(final String lTld) {
@@ -2320,7 +2320,7 @@ public class DomainValidator implements Serializable {
* {@link #isValidInfrastructureTld(String)}, {@link
#isValidGenericTld(String)} and {@link #isValidCountryCodeTld(String)}.
* </p>
*
- * @param tld the parameter to check for TLD status, not null.
+ * @param tld The parameter to check for TLD status, not null.
* @return true if the parameter is a TLD.
*/
public boolean isValidTld(final String tld) {
diff --git
a/src/main/java/org/apache/commons/validator/routines/IBANValidator.java
b/src/main/java/org/apache/commons/validator/routines/IBANValidator.java
index 516f9a73..3052fb09 100644
--- a/src/main/java/org/apache/commons/validator/routines/IBANValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/IBANValidator.java
@@ -91,9 +91,9 @@ public class IBANValidator {
/**
* Creates the validator.
*
- * @param countryCode the country code.
- * @param ibanLength the length of the IBAN.
- * @param regexWithCC the regex to use to check the format, the regex
MUST start with the country code.
+ * @param countryCode The country code.
+ * @param ibanLength The length of the IBAN.
+ * @param regexWithCC The regex to use to check the format, the regex
MUST start with the country code.
*/
public Validator(final String countryCode, final int ibanLength, final
String regexWithCC) {
this(countryCode, ibanLength,
regexWithCC.substring(countryCode.length()), new String[] {});
@@ -102,9 +102,9 @@ public class IBANValidator {
/**
* Creates the validator.
*
- * @param countryCode the country code.
- * @param ibanLength the length of the IBAN.
- * @param regexWithoutCC the regex to use to check the format, the
regex MUST NOT start with the country code.
+ * @param countryCode The country code.
+ * @param ibanLength The length of the IBAN.
+ * @param regexWithoutCC The regex to use to check the format, the
regex MUST NOT start with the country code.
*/
Validator(final String countryCode, final int ibanLength, final String
regexWithoutCC, final String... otherCountryCodes) {
if (!(countryCode.length() == 2 &&
Character.isUpperCase(countryCode.charAt(0)) &&
Character.isUpperCase(countryCode.charAt(1)))) {
@@ -329,7 +329,7 @@ public class IBANValidator {
/**
* Gets the Validator for a given IBAN.
*
- * @param code a string starting with the ISO country code (for example,
an IBAN).
+ * @param code A string starting with the ISO country code (for example,
an IBAN).
* @return The validator or {@code null} if there is not one registered.
*/
public Validator getValidator(final String code) {
@@ -343,7 +343,7 @@ public class IBANValidator {
/**
* Tests if the given code has a validator.
*
- * @param code the code to check.
+ * @param code The code to check.
* @return true if there is a validator.
*/
public boolean hasValidator(final String code) {
@@ -363,9 +363,9 @@ public class IBANValidator {
/**
* Installs a validator. Will replace any existing entry which has the
same countryCode.
*
- * @param countryCode the country code.
- * @param length the length of the IBAN. Must be ≥ 8 and ≤ 32.
If the length is < 0, the validator is removed, and the format is not used.
- * @param format the format of the IBAN (as a regular expression).
+ * @param countryCode The country code.
+ * @param length The length of the IBAN. Must be ≥ 8 and ≤ 32.
If the length is < 0, the validator is removed, and the format is not used.
+ * @param format The format of the IBAN (as a regular expression).
* @return The previous Validator, or {@code null} if there was none.
* @throws IllegalArgumentException if there is a problem.
* @throws IllegalStateException if an attempt is made to modify the
singleton validator.
@@ -389,7 +389,7 @@ public class IBANValidator {
/**
* Installs a validator. Will replace any existing entry which has the
same countryCode.
*
- * @param validator the instance to install.
+ * @param validator The instance to install.
* @return The previous Validator, or {@code null} if there was none.
* @throws IllegalStateException if an attempt is made to modify the
singleton validator.
*/
diff --git
a/src/main/java/org/apache/commons/validator/routines/ISSNValidator.java
b/src/main/java/org/apache/commons/validator/routines/ISSNValidator.java
index 0947fec3..426065c8 100644
--- a/src/main/java/org/apache/commons/validator/routines/ISSNValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/ISSNValidator.java
@@ -109,7 +109,7 @@ public class ISSNValidator implements Serializable {
* </p>
*
* @param issn The ISSN code to convert
- * @param suffix the two digit suffix, for example, "00"
+ * @param suffix The two digit suffix, for example, "00"
* @return A converted EAN-13 code or {@code null}
* if the input ISSN code is not valid
*/
diff --git
a/src/main/java/org/apache/commons/validator/routines/InetAddressValidator.java
b/src/main/java/org/apache/commons/validator/routines/InetAddressValidator.java
index 5b7259ff..c07c3060 100644
---
a/src/main/java/org/apache/commons/validator/routines/InetAddressValidator.java
+++
b/src/main/java/org/apache/commons/validator/routines/InetAddressValidator.java
@@ -87,7 +87,7 @@ public class InetAddressValidator implements Serializable {
/**
* Tests if the specified string is a valid IPv4 or IPv6 address.
*
- * @param inetAddress the string to validate
+ * @param inetAddress The string to validate
* @return true if the string validates as an IP address
*/
public boolean isValid(final String inetAddress) {
@@ -97,7 +97,7 @@ public class InetAddressValidator implements Serializable {
/**
* Validates an IPv4 address. Returns true if valid.
*
- * @param inet4Address the IPv4 address to validate
+ * @param inet4Address The IPv4 address to validate
* @return true if the argument contains a valid IPv4 address
*/
public boolean isValidInet4Address(final String inet4Address) {
@@ -127,7 +127,7 @@ public class InetAddressValidator implements Serializable {
/**
* Validates an IPv6 address. Returns true if valid.
*
- * @param inet6Address the IPv6 address to validate
+ * @param inet6Address The IPv6 address to validate
* @return true if the argument contains a valid IPv6 address
* @since 1.4.1
*/
diff --git
a/src/main/java/org/apache/commons/validator/routines/TimeValidator.java
b/src/main/java/org/apache/commons/validator/routines/TimeValidator.java
index 813ada46..19f2b07b 100644
--- a/src/main/java/org/apache/commons/validator/routines/TimeValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/TimeValidator.java
@@ -110,7 +110,7 @@ public class TimeValidator extends
AbstractCalendarValidator {
*
* @param strict {@code true} if strict
* {@code Format} parsing should be used.
- * @param timeStyle the time style to use for Locale validation.
+ * @param timeStyle The time style to use for Locale validation.
*/
public TimeValidator(final boolean strict, final int timeStyle) {
super(strict, -1, timeStyle);
diff --git
a/src/main/java/org/apache/commons/validator/routines/UrlValidator.java
b/src/main/java/org/apache/commons/validator/routines/UrlValidator.java
index 775207db..901bd5fb 100644
--- a/src/main/java/org/apache/commons/validator/routines/UrlValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/UrlValidator.java
@@ -267,7 +267,7 @@ public class UrlValidator implements Serializable {
/**
* Customizable constructor. Validation behavior is modified by passing in
options.
*
- * @param schemes the set of valid schemes. Ignored if the
ALLOW_ALL_SCHEMES option is set.
+ * @param schemes The set of valid schemes. Ignored if the
ALLOW_ALL_SCHEMES option is set.
* @param authorityValidator Regular expression validator used to validate
the authority part
* @param options Validation options. Set using the public constants of
this class.
* To set multiple options, simply add them together:
@@ -281,13 +281,13 @@ public class UrlValidator implements Serializable {
/**
* Customizable constructor. Validation behavior is modified by passing in
options.
*
- * @param schemes the set of valid schemes. Ignored if the
ALLOW_ALL_SCHEMES option is set.
+ * @param schemes The set of valid schemes. Ignored if the
ALLOW_ALL_SCHEMES option is set.
* @param authorityValidator Regular expression validator used to validate
the authority part
* @param options Validation options. Set using the public constants of
this class.
* To set multiple options, simply add them together:
* <p>{@code ALLOW_2_SLASHES + NO_FRAGMENTS}</p>
* enables both of those options.
- * @param domainValidator the DomainValidator to use; must agree with
ALLOW_LOCAL_URLS setting
+ * @param domainValidator The DomainValidator to use; must agree with
ALLOW_LOCAL_URLS setting
* @since 1.7
*/
public UrlValidator(String[] schemes, final RegexValidator
authorityValidator, final long options, final DomainValidator domainValidator) {
diff --git
a/src/main/java/org/apache/commons/validator/routines/checkdigit/ModulusTenCheckDigit.java
b/src/main/java/org/apache/commons/validator/routines/checkdigit/ModulusTenCheckDigit.java
index 9fb7b8ca..61f9dd56 100644
---
a/src/main/java/org/apache/commons/validator/routines/checkdigit/ModulusTenCheckDigit.java
+++
b/src/main/java/org/apache/commons/validator/routines/checkdigit/ModulusTenCheckDigit.java
@@ -142,7 +142,7 @@ public final class ModulusTenCheckDigit extends
ModulusCheckDigit {
/**
* Constructs a modulus 10 Check Digit routine with the specified
weighting from left to right.
*
- * @param positionWeight the weighted values to apply based on the
character position
+ * @param positionWeight The weighted values to apply based on the
character position
*/
public ModulusTenCheckDigit(final int[] positionWeight) {
this(positionWeight, false, false);
@@ -151,7 +151,7 @@ public final class ModulusTenCheckDigit extends
ModulusCheckDigit {
/**
* Constructs a modulus 10 Check Digit routine with the specified
weighting, indicating whether its from the left or right.
*
- * @param positionWeight the weighted values to apply based on the
character position
+ * @param positionWeight The weighted values to apply based on the
character position
* @param useRightPos {@code true} if use positionWeights from right to
left
*/
public ModulusTenCheckDigit(final int[] positionWeight, final boolean
useRightPos) {
@@ -162,7 +162,7 @@ public final class ModulusTenCheckDigit extends
ModulusCheckDigit {
* Constructs a modulus 10 Check Digit routine with the specified
weighting, indicating whether its from the left or right and whether the
weighted digits
* should be summed.
*
- * @param positionWeight the weighted values to apply based on the
character position
+ * @param positionWeight The weighted values to apply based on the
character position
* @param useRightPos {@code true} if use positionWeights from right
to left
* @param sumWeightedDigits {@code true} if sum the digits of the weighted
value
*/
diff --git
a/src/test/java/org/apache/commons/validator/GenericTypeValidatorImpl.java
b/src/test/java/org/apache/commons/validator/GenericTypeValidatorImpl.java
index 6583a230..e147cbc0 100644
--- a/src/test/java/org/apache/commons/validator/GenericTypeValidatorImpl.java
+++ b/src/test/java/org/apache/commons/validator/GenericTypeValidatorImpl.java
@@ -30,7 +30,7 @@ public class GenericTypeValidatorImpl {
* Checks if the field can be successfully converted to a {@code byte}.
*
* @param bean The value validation is being performed on.
- * @param field the field to use
+ * @param field The field to use
* @return boolean If the field can be successfully converted to a {@code
byte} {@code true} is returned. Otherwise {@code false}.
*/
public static Byte validateByte(final Object bean, final Field field) {
@@ -43,7 +43,7 @@ public class GenericTypeValidatorImpl {
* Checks if the field can be successfully converted to a {@code byte}.
*
* @param bean The value validation is being performed on.
- * @param field the field to use
+ * @param field The field to use
* @return boolean If the field can be successfully converted to a {@code
byte} {@code true} is returned. Otherwise {@code false}.
*/
public static Byte validateByte(final Object bean, final Field field,
final Locale locale) {
@@ -56,7 +56,7 @@ public class GenericTypeValidatorImpl {
* Checks if the field can be successfully converted to a {@code date}.
*
* @param bean The value validation is being performed on.
- * @param field the field to use
+ * @param field The field to use
* @return boolean If the field can be successfully converted to a {@code
date} {@code true} is returned. Otherwise {@code false}.
*/
public static Date validateDate(final Object bean, final Field field) {
@@ -78,7 +78,7 @@ public class GenericTypeValidatorImpl {
* Checks if the field can be successfully converted to a {@code date}.
*
* @param bean The value validation is being performed on.
- * @param field the field to use
+ * @param field The field to use
* @return boolean If the field can be successfully converted to a {@code
date} {@code true} is returned. Otherwise {@code false}.
*/
public static Date validateDate(final Object bean, final Field field,
final Locale locale) {
@@ -91,7 +91,7 @@ public class GenericTypeValidatorImpl {
* Checks if the field can be successfully converted to a {@code double}.
*
* @param bean The value validation is being performed on.
- * @param field the field to use
+ * @param field The field to use
* @return boolean If the field can be successfully converted to a {@code
double} {@code true} is returned. Otherwise {@code false}.
*/
public static Double validateDouble(final Object bean, final Field field) {
@@ -104,7 +104,7 @@ public class GenericTypeValidatorImpl {
* Checks if the field can be successfully converted to a {@code double}.
*
* @param bean The value validation is being performed on.
- * @param field the field to use
+ * @param field The field to use
* @return boolean If the field can be successfully converted to a {@code
double} {@code true} is returned. Otherwise {@code false}.
*/
public static Double validateDouble(final Object bean, final Field field,
final Locale locale) {
@@ -117,7 +117,7 @@ public class GenericTypeValidatorImpl {
* Checks if the field can be successfully converted to a {@code float}.
*
* @param bean The value validation is being performed on.
- * @param field the field to use
+ * @param field The field to use
* @return boolean If the field can be successfully converted to a {@code
float} {@code true} is returned. Otherwise {@code false}.
*/
public static Float validateFloat(final Object bean, final Field field) {
@@ -130,7 +130,7 @@ public class GenericTypeValidatorImpl {
* Checks if the field can be successfully converted to a {@code float}.
*
* @param bean The value validation is being performed on.
- * @param field the field to use
+ * @param field The field to use
* @return boolean If the field can be successfully converted to a {@code
float} {@code true} is returned. Otherwise {@code false}.
*/
public static Float validateFloat(final Object bean, final Field field,
final Locale locale) {
@@ -143,7 +143,7 @@ public class GenericTypeValidatorImpl {
* Checks if the field can be successfully converted to a {@code int}.
*
* @param bean The value validation is being performed on.
- * @param field the field to use
+ * @param field The field to use
* @return boolean If the field can be successfully converted to a {@code
int} {@code true} is returned. Otherwise {@code false}.
*/
public static Integer validateInt(final Object bean, final Field field) {
@@ -156,7 +156,7 @@ public class GenericTypeValidatorImpl {
* Checks if the field can be successfully converted to a {@code int}.
*
* @param bean The value validation is being performed on.
- * @param field the field to use
+ * @param field The field to use
* @return boolean If the field can be successfully converted to a {@code
int} {@code true} is returned. Otherwise {@code false}.
*/
public static Integer validateInt(final Object bean, final Field field,
final Locale locale) {
@@ -169,7 +169,7 @@ public class GenericTypeValidatorImpl {
* Checks if the field can be successfully converted to a {@code long}.
*
* @param bean The value validation is being performed on.
- * @param field the field to use
+ * @param field The field to use
* @return boolean If the field can be successfully converted to a {@code
long} {@code true} is returned. Otherwise {@code false}.
*/
public static Long validateLong(final Object bean, final Field field) {
@@ -182,7 +182,7 @@ public class GenericTypeValidatorImpl {
* Checks if the field can be successfully converted to a {@code long}.
*
* @param bean The value validation is being performed on.
- * @param field the field to use
+ * @param field The field to use
* @return boolean If the field can be successfully converted to a {@code
long} {@code true} is returned. Otherwise {@code false}.
*/
public static Long validateLong(final Object bean, final Field field,
final Locale locale) {
@@ -195,7 +195,7 @@ public class GenericTypeValidatorImpl {
* Checks if the field can be successfully converted to a {@code short}.
*
* @param bean The value validation is being performed on.
- * @param field the field to use
+ * @param field The field to use
* @return boolean If the field can be successfully converted to a {@code
short} {@code true} is returned. Otherwise {@code false}.
*/
public static Short validateShort(final Object bean, final Field field) {
@@ -208,7 +208,7 @@ public class GenericTypeValidatorImpl {
* Checks if the field can be successfully converted to a {@code short}.
*
* @param bean The value validation is being performed on.
- * @param field the field to use
+ * @param field The field to use
* @return boolean If the field can be successfully converted to a {@code
short} {@code true} is returned. Otherwise {@code false}.
*/
public static Short validateShort(final Object bean, final Field field,
final Locale locale) {
diff --git
a/src/test/java/org/apache/commons/validator/GenericValidatorImpl.java
b/src/test/java/org/apache/commons/validator/GenericValidatorImpl.java
index 6d71abea..871dfbf0 100644
--- a/src/test/java/org/apache/commons/validator/GenericValidatorImpl.java
+++ b/src/test/java/org/apache/commons/validator/GenericValidatorImpl.java
@@ -40,7 +40,7 @@ public class GenericValidatorImpl {
* Checks if the field can be successfully converted to a {@code byte}.
*
* @param bean The value validation is being performed on.
- * @param field the field to use
+ * @param field The field to use
* @return boolean If the field can be successfully converted to a {@code
byte} {@code true} is returned. Otherwise {@code false}.
*/
public static boolean validateByte(final Object bean, final Field field) {
@@ -53,7 +53,7 @@ public class GenericValidatorImpl {
* Checks if the field can be successfully converted to a {@code double}.
*
* @param bean The value validation is being performed on.
- * @param field the field to use
+ * @param field The field to use
* @return boolean If the field can be successfully converted to a {@code
double} {@code true} is returned. Otherwise {@code false}.
*/
public static boolean validateDouble(final Object bean, final Field field)
{
@@ -66,7 +66,7 @@ public class GenericValidatorImpl {
* Checks if the field is an e-mail address.
*
* @param bean The value validation is being performed on.
- * @param field the field to use
+ * @param field The field to use
* @return boolean If the field is an e-mail address {@code true} is
returned. Otherwise {@code false}.
*/
public static boolean validateEmail(final Object bean, final Field field) {
@@ -79,7 +79,7 @@ public class GenericValidatorImpl {
* Checks if the field can be successfully converted to a {@code float}.
*
* @param bean The value validation is being performed on.
- * @param field the field to use
+ * @param field The field to use
* @return boolean If the field can be successfully converted to a {@code
float} {@code true} is returned. Otherwise {@code false}.
*/
public static boolean validateFloat(final Object bean, final Field field) {
@@ -92,7 +92,7 @@ public class GenericValidatorImpl {
* Checks if the field can be successfully converted to a {@code int}.
*
* @param bean The value validation is being performed on.
- * @param field the field to use
+ * @param field The field to use
* @return boolean If the field can be successfully converted to a {@code
int} {@code true} is returned. Otherwise {@code false}.
*/
public static boolean validateInt(final Object bean, final Field field) {
@@ -105,7 +105,7 @@ public class GenericValidatorImpl {
* Checks if the field can be successfully converted to a {@code long}.
*
* @param bean The value validation is being performed on.
- * @param field the field to use
+ * @param field The field to use
* @return boolean If the field can be successfully converted to a {@code
long} {@code true} is returned. Otherwise {@code false}.
*/
public static boolean validateLong(final Object bean, final Field field) {
@@ -233,7 +233,7 @@ public class GenericValidatorImpl {
* Checks if the field can be successfully converted to a {@code short}.
*
* @param bean The value validation is being performed on.
- * @param field the field to use
+ * @param field The field to use
* @return boolean If the field can be successfully converted to a {@code
short} {@code true} is returned. Otherwise {@code false}.
*/
public static boolean validateShort(final Object bean, final Field field) {
diff --git
a/src/test/java/org/apache/commons/validator/routines/AbstractCalendarValidatorTest.java
b/src/test/java/org/apache/commons/validator/routines/AbstractCalendarValidatorTest.java
index 37ef1c33..6d7d5322 100644
---
a/src/test/java/org/apache/commons/validator/routines/AbstractCalendarValidatorTest.java
+++
b/src/test/java/org/apache/commons/validator/routines/AbstractCalendarValidatorTest.java
@@ -45,7 +45,7 @@ public abstract class AbstractCalendarValidatorTest {
*
* @param zone The time zone
* @param date The date in yyyyMMdd format
- * @param time the time in HH:mm:ss format
+ * @param time The time in HH:mm:ss format
* @return The new Calendar instance.
*/
protected static Calendar createCalendar(final TimeZone zone, final int
date, final int time) {
@@ -71,7 +71,7 @@ public abstract class AbstractCalendarValidatorTest {
*
* @param zone The time zone
* @param date The date in yyyyMMdd format
- * @param time the time in HH:mm:ss format
+ * @param time The time in HH:mm:ss format
* @return The new Date instance.
*/
protected static Date createDate(final TimeZone zone, final int date,
final int time) {
diff --git
a/src/test/java/org/apache/commons/validator/routines/DomainValidatorTest.java
b/src/test/java/org/apache/commons/validator/routines/DomainValidatorTest.java
index cc306716..f2627756 100644
---
a/src/test/java/org/apache/commons/validator/routines/DomainValidatorTest.java
+++
b/src/test/java/org/apache/commons/validator/routines/DomainValidatorTest.java
@@ -178,7 +178,7 @@ public class DomainValidatorTest {
* Check whether the domain is in the root zone currently. Reads the URL
https://www.iana.org/domains/root/db/*domain*.html (using a local disk cache)
and
* checks for the string "This domain is not present in the root zone at
this time."
*
- * @param domain the domain to check
+ * @param domain The domain to check
* @return true if the string is found
*/
private static boolean isNotInRootZone(final String domain) {
diff --git
a/src/test/java/org/apache/commons/validator/routines/TimeValidatorTest.java
b/src/test/java/org/apache/commons/validator/routines/TimeValidatorTest.java
index 5977cae0..05ff513d 100644
--- a/src/test/java/org/apache/commons/validator/routines/TimeValidatorTest.java
+++ b/src/test/java/org/apache/commons/validator/routines/TimeValidatorTest.java
@@ -46,8 +46,8 @@ class TimeValidatorTest {
* Create a date instance for a specified time zone, date and time.
*
* @param zone The time zone
- * @param time the time in HH:mm:ss format
- * @param millisecond the milliseconds
+ * @param time The time in HH:mm:ss format
+ * @param millisecond The milliseconds
* @return The new Date instance.
*/
protected static Date createDate(final TimeZone zone, final int time,
final int millisecond) {
@@ -59,8 +59,8 @@ class TimeValidatorTest {
* Create a calendar instance for a specified time zone, date and time.
*
* @param zone The time zone
- * @param time the time in HH:mm:ss format
- * @param millisecond the milliseconds
+ * @param time The time in HH:mm:ss format
+ * @param millisecond The milliseconds
* @return The new Calendar instance.
*/
protected static Calendar createTime(final TimeZone zone, final int time,
final int millisecond) {
