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 2d8a90be Javadoc
2d8a90be is described below
commit 2d8a90bed63139cc9d2b4489f90c62960815eeb0
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 08:46:51 2026 -0400
Javadoc
---
.../java/org/apache/commons/validator/Arg.java | 6 ++---
.../java/org/apache/commons/validator/Field.java | 6 ++---
.../commons/validator/GenericTypeValidator.java | 30 +++++++++++-----------
.../apache/commons/validator/GenericValidator.java | 2 +-
.../org/apache/commons/validator/UrlValidator.java | 2 +-
.../org/apache/commons/validator/Validator.java | 12 ++++-----
.../routines/AbstractNumberValidator.java | 2 +-
.../validator/routines/CreditCardValidator.java | 6 ++---
.../validator/routines/DomainValidator.java | 4 +--
.../commons/validator/routines/IBANValidator.java | 10 ++++----
.../validator/routines/InetAddressValidator.java | 2 +-
.../commons/validator/routines/UrlValidator.java | 2 +-
.../org/apache/commons/validator/util/Flags.java | 2 +-
.../routines/AbstractCalendarValidatorTest.java | 4 +--
.../validator/routines/TimeValidatorTest.java | 4 +--
15 files changed, 47 insertions(+), 47 deletions(-)
diff --git a/src/main/java/org/apache/commons/validator/Arg.java
b/src/main/java/org/apache/commons/validator/Arg.java
index 787b995b..feb35a2a 100644
--- a/src/main/java/org/apache/commons/validator/Arg.java
+++ b/src/main/java/org/apache/commons/validator/Arg.java
@@ -94,7 +94,7 @@ public class Arg implements Cloneable, Serializable {
/**
* Gets the resource bundle name.
*
- * @return the bundle name.
+ * @return The bundle name.
* @since 1.1
*/
public String getBundle() {
@@ -104,7 +104,7 @@ public class Arg implements Cloneable, Serializable {
/**
* Gets the key/value.
*
- * @return the key value.
+ * @return The key value.
*/
public String getKey() {
return key;
@@ -113,7 +113,7 @@ public class Arg implements Cloneable, Serializable {
/**
* Gets the name of the dependency.
*
- * @return the name of the dependency.
+ * @return The name of the dependency.
*/
public String getName() {
return name;
diff --git a/src/main/java/org/apache/commons/validator/Field.java
b/src/main/java/org/apache/commons/validator/Field.java
index 970af871..719b04ff 100644
--- a/src/main/java/org/apache/commons/validator/Field.java
+++ b/src/main/java/org/apache/commons/validator/Field.java
@@ -547,7 +547,7 @@ public class Field implements Cloneable, Serializable {
* Retrieve a variable.
*
* @param mainKey The Variable's key
- * @return the Variable
+ * @return The Variable
*/
public Var getVar(final String mainKey) {
return getVarMap().get(mainKey);
@@ -568,7 +568,7 @@ public class Field implements Cloneable, Serializable {
* The {@code Field}'s variables are returned as an
* unmodifiable {@link Map}.
*
- * @return the Map of Variable's for a Field.
+ * @return The Map of Variable's for a Field.
*/
public Map<String, Var> getVars() {
return Collections.unmodifiableMap(getVarMap());
@@ -578,7 +578,7 @@ public class Field implements Cloneable, Serializable {
* Retrieve a variable's value.
*
* @param mainKey The Variable's key
- * @return the Variable's value
+ * @return The Variable's value
*/
public String getVarValue(final String mainKey) {
String value = null;
diff --git
a/src/main/java/org/apache/commons/validator/GenericTypeValidator.java
b/src/main/java/org/apache/commons/validator/GenericTypeValidator.java
index 24e541fc..62fe3f44 100644
--- a/src/main/java/org/apache/commons/validator/GenericTypeValidator.java
+++ b/src/main/java/org/apache/commons/validator/GenericTypeValidator.java
@@ -41,7 +41,7 @@ public class GenericTypeValidator implements Serializable {
* Checks if the value can safely be converted to a byte primitive.
*
* @param value The value validation is being performed on.
- * @return the converted Byte value.
+ * @return The converted Byte value.
*/
public static Byte formatByte(final String value) {
if (value == null) {
@@ -59,7 +59,7 @@ public class GenericTypeValidator implements Serializable {
*
* @param value The value validation is being performed on.
* @param locale The locale to use to parse the number (system default if
null)
- * @return the converted Byte value.
+ * @return The converted Byte value.
*/
public static Byte formatByte(final String value, final Locale locale) {
Byte result = null;
@@ -82,7 +82,7 @@ public class GenericTypeValidator implements Serializable {
* </p>
*
* @param value The value validation is being performed on.
- * @return the converted Credit Card number.
+ * @return The converted Credit Card number.
*/
public static Long formatCreditCard(final String value) {
return GenericValidator.isCreditCard(value) ? Long.valueOf(value) :
null;
@@ -98,7 +98,7 @@ public class GenericTypeValidator implements Serializable {
*
* @param value The value validation is being performed on.
* @param locale The Locale to use to parse the date (system default if
null)
- * @return the converted Date value.
+ * @return The converted Date value.
*/
public static Date formatDate(final String value, final Locale locale) {
Date date = null;
@@ -140,7 +140,7 @@ public class GenericTypeValidator implements Serializable {
* @param value The value validation is being performed on.
* @param datePattern The pattern passed to {@link SimpleDateFormat}.
* @param strict Whether or not to have an exact match of the
datePattern.
- * @return the converted Date value.
+ * @return The converted Date value.
*/
public static Date formatDate(final String value, final String
datePattern, final boolean strict) {
Date date = null;
@@ -167,7 +167,7 @@ public class GenericTypeValidator implements Serializable {
* Checks if the value can safely be converted to a double primitive.
*
* @param value The value validation is being performed on.
- * @return the converted Double value.
+ * @return The converted Double value.
*/
public static Double formatDouble(final String value) {
if (value == null) {
@@ -185,7 +185,7 @@ public class GenericTypeValidator implements Serializable {
*
* @param value The value validation is being performed on.
* @param locale The locale to use to parse the number (system default if
null)
- * @return the converted Double value.
+ * @return The converted Double value.
*/
public static Double formatDouble(final String value, final Locale locale)
{
Double result = null;
@@ -205,7 +205,7 @@ public class GenericTypeValidator implements Serializable {
* Checks if the value can safely be converted to a float primitive.
*
* @param value The value validation is being performed on.
- * @return the converted Float value.
+ * @return The converted Float value.
*/
public static Float formatFloat(final String value) {
if (value == null) {
@@ -223,7 +223,7 @@ public class GenericTypeValidator implements Serializable {
*
* @param value The value validation is being performed on.
* @param locale The locale to use to parse the number (system default if
null)
- * @return the converted Float value.
+ * @return The converted Float value.
*/
public static Float formatFloat(final String value, final Locale locale) {
Float result = null;
@@ -243,7 +243,7 @@ public class GenericTypeValidator implements Serializable {
* Checks if the value can safely be converted to an int primitive.
*
* @param value The value validation is being performed on.
- * @return the converted Integer value.
+ * @return The converted Integer value.
*/
public static Integer formatInt(final String value) {
if (value == null) {
@@ -261,7 +261,7 @@ public class GenericTypeValidator implements Serializable {
*
* @param value The value validation is being performed on.
* @param locale The locale to use to parse the number (system default if
null)
- * @return the converted Integer value.
+ * @return The converted Integer value.
*/
public static Integer formatInt(final String value, final Locale locale) {
Integer result = null;
@@ -282,7 +282,7 @@ public class GenericTypeValidator implements Serializable {
* Checks if the value can safely be converted to a long primitive.
*
* @param value The value validation is being performed on.
- * @return the converted Long value.
+ * @return The converted Long value.
*/
public static Long formatLong(final String value) {
if (value == null) {
@@ -300,7 +300,7 @@ public class GenericTypeValidator implements Serializable {
*
* @param value The value validation is being performed on.
* @param locale The locale to use to parse the number (system default if
null)
- * @return the converted Long value.
+ * @return The converted Long value.
*/
public static Long formatLong(final String value, final Locale locale) {
Long result = null;
@@ -326,7 +326,7 @@ public class GenericTypeValidator implements Serializable {
* Checks if the value can safely be converted to a short primitive.
*
* @param value The value validation is being performed on.
- * @return the converted Short value.
+ * @return The converted Short value.
*/
public static Short formatShort(final String value) {
if (value == null) {
@@ -344,7 +344,7 @@ public class GenericTypeValidator implements Serializable {
*
* @param value The value validation is being performed on.
* @param locale The locale to use to parse the number (system default if
null)
- * @return the converted Short value.
+ * @return The converted Short value.
*/
public static Short formatShort(final String value, final Locale locale) {
Short result = null;
diff --git a/src/main/java/org/apache/commons/validator/GenericValidator.java
b/src/main/java/org/apache/commons/validator/GenericValidator.java
index cdc853b5..d212aa06 100644
--- a/src/main/java/org/apache/commons/validator/GenericValidator.java
+++ b/src/main/java/org/apache/commons/validator/GenericValidator.java
@@ -39,7 +39,7 @@ public class GenericValidator implements Serializable {
*
* @param value The value validation is being performed on.
* @param lineEndLength The length to use for line endings.
- * @return the adjustment amount.
+ * @return The adjustment amount.
*/
private static int adjustForLineEnding(final String value, final int
lineEndLength) {
int nCount = 0;
diff --git a/src/main/java/org/apache/commons/validator/UrlValidator.java
b/src/main/java/org/apache/commons/validator/UrlValidator.java
index b454ae1e..dce0ac78 100644
--- a/src/main/java/org/apache/commons/validator/UrlValidator.java
+++ b/src/main/java/org/apache/commons/validator/UrlValidator.java
@@ -244,7 +244,7 @@ public class UrlValidator implements Serializable {
*
* @param token Token value to be counted.
* @param target Target value to count tokens in.
- * @return the number of tokens.
+ * @return The number of tokens.
*/
protected int countToken(final String token, final String target) {
int tokenIndex = 0;
diff --git a/src/main/java/org/apache/commons/validator/Validator.java
b/src/main/java/org/apache/commons/validator/Validator.java
index 1f3e7a04..c8369ee8 100644
--- a/src/main/java/org/apache/commons/validator/Validator.java
+++ b/src/main/java/org/apache/commons/validator/Validator.java
@@ -239,7 +239,7 @@ public class Validator implements Serializable {
* <li>The class loader used to load the Digester class itself.</li>
* </ul>
*
- * @return the class loader.
+ * @return The class loader.
*/
public ClassLoader getClassLoader() {
if (classLoader != null) {
@@ -259,7 +259,7 @@ public class Validator implements Serializable {
/**
* Gets the field name.
*
- * @return the field name.
+ * @return The field name.
* @since 1.10.0
*/
public String getFieldName() {
@@ -269,7 +269,7 @@ public class Validator implements Serializable {
/**
* Gets the form name which is the key to a set of validation rules.
*
- * @return the name of the form.
+ * @return The name of the form.
*/
public String getFormName() {
return formName;
@@ -293,7 +293,7 @@ public class Validator implements Serializable {
* page is less than or equal to this page value, it will be processed.
* </p>
*
- * @return the page number.
+ * @return The page number.
*/
public int getPage() {
return page;
@@ -302,7 +302,7 @@ public class Validator implements Serializable {
/**
* Gets the parameter map.
*
- * @return the parameter map.
+ * @return The parameter map.
* @since 1.10.0
*/
public Map<String, Object> getParameters() {
@@ -324,7 +324,7 @@ public class Validator implements Serializable {
/**
* Gets the validator resource.
*
- * @return the validator resource.
+ * @return The validator resource.
* @since 1.10.0
*/
public ValidatorResources getResources() {
diff --git
a/src/main/java/org/apache/commons/validator/routines/AbstractNumberValidator.java
b/src/main/java/org/apache/commons/validator/routines/AbstractNumberValidator.java
index 0e3390a0..28ee803f 100644
---
a/src/main/java/org/apache/commons/validator/routines/AbstractNumberValidator.java
+++
b/src/main/java/org/apache/commons/validator/routines/AbstractNumberValidator.java
@@ -229,7 +229,7 @@ public abstract class AbstractNumberValidator extends
AbstractFormatValidator {
/**
* Gets the type of {@code NumberFormat} created by this validator
instance.
*
- * @return the format type created.
+ * @return The format type created.
*/
public int getFormatType() {
return formatType;
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 c839d079..ec26d832 100644
---
a/src/main/java/org/apache/commons/validator/routines/CreditCardValidator.java
+++
b/src/main/java/org/apache/commons/validator/routines/CreditCardValidator.java
@@ -336,7 +336,7 @@ public class CreditCardValidator implements Serializable {
* Creates a new generic CreditCardValidator which validates the syntax
and check digit only.
* Does not check the Issuer Identification Number (IIN)
*
- * @return the validator
+ * @return The validator
* @since 1.6
*/
public static CreditCardValidator genericCreditCardValidator() {
@@ -348,7 +348,7 @@ public class CreditCardValidator implements Serializable {
* Does not check the Issuer Identification Number (IIN)
*
* @param length exact length
- * @return the validator
+ * @return The validator
* @since 1.6
*/
public static CreditCardValidator genericCreditCardValidator(final int
length) {
@@ -361,7 +361,7 @@ public class CreditCardValidator implements Serializable {
*
* @param minLen minimum allowed length
* @param maxLen maximum allowed length
- * @return the validator
+ * @return The validator
* @since 1.6
*/
public static CreditCardValidator genericCreditCardValidator(final int
minLen, final int maxLen) {
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 0b097ed9..fe0b6387 100644
--- a/src/main/java/org/apache/commons/validator/routines/DomainValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/DomainValidator.java
@@ -1836,7 +1836,7 @@ public class DomainValidator implements Serializable {
/**
* Gets the singleton instance of this validator. It will not consider
local addresses as valid.
*
- * @return the singleton instance of this validator.
+ * @return The singleton instance of this validator.
*/
public static synchronized DomainValidator getInstance() {
inUse = true;
@@ -1847,7 +1847,7 @@ public class DomainValidator implements Serializable {
* Gets the singleton instance of this validator, with local validation as
required.
*
* @param allowLocal Whether local addresses are considered valid.
- * @return the singleton instance of this validator.
+ * @return The singleton instance of this validator.
*/
public static synchronized DomainValidator getInstance(final boolean
allowLocal) {
inUse = true;
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 1a628ba2..66dd90ff 100644
--- a/src/main/java/org/apache/commons/validator/routines/IBANValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/IBANValidator.java
@@ -127,7 +127,7 @@ public class IBANValidator {
/**
* Gets the length.
*
- * @return the length.
+ * @return The length.
* @since 1.10.0
*/
public int getIbanLength() {
@@ -137,7 +137,7 @@ public class IBANValidator {
/**
* Gets the RegexValidator.
*
- * @return the RegexValidator.
+ * @return The RegexValidator.
* @since 1.8
*/
public RegexValidator getRegexValidator() {
@@ -330,7 +330,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).
- * @return the validator or {@code null} if there is not one registered.
+ * @return The validator or {@code null} if there is not one registered.
*/
public Validator getValidator(final String code) {
if (code == null || code.length() < SHORT_CODE_LEN) { // ensure we can
extract the code
@@ -366,7 +366,7 @@ public class IBANValidator {
* @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.
+ * @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.
*/
@@ -390,7 +390,7 @@ public class IBANValidator {
* Installs a validator. Will replace any existing entry which has the
same countryCode.
*
* @param validator the instance to install.
- * @return the previous Validator, or {@code null} if there was none.
+ * @return The previous Validator, or {@code null} if there was none.
* @throws IllegalStateException if an attempt is made to modify the
singleton validator.
*/
public Validator setValidator(final Validator validator) {
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 ec9dd830..5b7259ff 100644
---
a/src/main/java/org/apache/commons/validator/routines/InetAddressValidator.java
+++
b/src/main/java/org/apache/commons/validator/routines/InetAddressValidator.java
@@ -71,7 +71,7 @@ public class InetAddressValidator implements Serializable {
/**
* Gets the singleton instance of this validator.
*
- * @return the singleton instance of this validator
+ * @return The singleton instance of this validator
*/
public static InetAddressValidator getInstance() {
return VALIDATOR;
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 4a9bf519..775207db 100644
--- a/src/main/java/org/apache/commons/validator/routines/UrlValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/UrlValidator.java
@@ -320,7 +320,7 @@ public class UrlValidator implements Serializable {
*
* @param token Token value to be counted.
* @param target Target value to count tokens in.
- * @return the number of tokens.
+ * @return The number of tokens.
*/
protected int countToken(final String token, final String target) {
int tokenIndex = 0;
diff --git a/src/main/java/org/apache/commons/validator/util/Flags.java
b/src/main/java/org/apache/commons/validator/util/Flags.java
index 29a5b266..083e049b 100644
--- a/src/main/java/org/apache/commons/validator/util/Flags.java
+++ b/src/main/java/org/apache/commons/validator/util/Flags.java
@@ -116,7 +116,7 @@ public class Flags implements Serializable, Cloneable {
* The hash code is based on the current state of the flags.
*
* @see Object#hashCode()
- * @return the hash code for this object.
+ * @return The hash code for this object.
*/
@Override
public int hashCode() {
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 a56d7029..37ef1c33 100644
---
a/src/test/java/org/apache/commons/validator/routines/AbstractCalendarValidatorTest.java
+++
b/src/test/java/org/apache/commons/validator/routines/AbstractCalendarValidatorTest.java
@@ -46,7 +46,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
- * @return the new Calendar instance.
+ * @return The new Calendar instance.
*/
protected static Calendar createCalendar(final TimeZone zone, final int
date, final int time) {
final Calendar calendar = zone == null ? Calendar.getInstance() :
Calendar.getInstance(zone);
@@ -72,7 +72,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
- * @return the new Date instance.
+ * @return The new Date instance.
*/
protected static Date createDate(final TimeZone zone, final int date,
final int time) {
final Calendar calendar = createCalendar(zone, date, time);
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 f436068e..5977cae0 100644
--- a/src/test/java/org/apache/commons/validator/routines/TimeValidatorTest.java
+++ b/src/test/java/org/apache/commons/validator/routines/TimeValidatorTest.java
@@ -48,7 +48,7 @@ class TimeValidatorTest {
* @param zone The time zone
* @param time the time in HH:mm:ss format
* @param millisecond the milliseconds
- * @return the new Date instance.
+ * @return The new Date instance.
*/
protected static Date createDate(final TimeZone zone, final int time,
final int millisecond) {
final Calendar calendar = createTime(zone, time, millisecond);
@@ -61,7 +61,7 @@ class TimeValidatorTest {
* @param zone The time zone
* @param time the time in HH:mm:ss format
* @param millisecond the milliseconds
- * @return the new Calendar instance.
+ * @return The new Calendar instance.
*/
protected static Calendar createTime(final TimeZone zone, final int time,
final int millisecond) {
final Calendar calendar = zone == null ? Calendar.getInstance() :
Calendar.getInstance(zone);
