(commons-validator) branch master updated: Javadoc

2024-07-21 Thread ggregory
This is an automated email from the ASF dual-hosted git repository.

ggregory 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 5969b6da Javadoc
5969b6da is described below

commit 5969b6dad1c9a65389d1d4039377a808085d6c28
Author: Gary Gregory 
AuthorDate: Sun Jul 21 11:50:27 2024 -0400

Javadoc

Use HTML 'em' tag instead of 'i' tag
---
 .../routines/AbstractCalendarValidator.java|  12 +-
 .../routines/AbstractFormatValidator.java  |   8 +-
 .../routines/AbstractNumberValidator.java  |  10 +-
 .../validator/routines/BigDecimalValidator.java|  16 +-
 .../validator/routines/BigIntegerValidator.java|  16 +-
 .../commons/validator/routines/ByteValidator.java  |  16 +-
 .../validator/routines/CalendarValidator.java  |  20 +--
 .../commons/validator/routines/CodeValidator.java  |  12 +-
 .../validator/routines/CurrencyValidator.java  |  12 +-
 .../commons/validator/routines/DateValidator.java  |  20 +--
 .../validator/routines/DoubleValidator.java|  16 +-
 .../commons/validator/routines/FloatValidator.java |  16 +-
 .../validator/routines/IntegerValidator.java   |  16 +-
 .../commons/validator/routines/LongValidator.java  |  18 +--
 .../validator/routines/PercentValidator.java   |  10 +-
 .../commons/validator/routines/RegexValidator.java |  20 +--
 .../commons/validator/routines/ShortValidator.java |  16 +-
 .../commons/validator/routines/TimeValidator.java  |  20 +--
 .../routines/checkdigit/ABANumberCheckDigit.java   |   4 +-
 .../routines/checkdigit/CASNumberCheckDigit.java   |   4 +-
 .../routines/checkdigit/CUSIPCheckDigit.java   |   4 +-
 .../validator/routines/checkdigit/CheckDigit.java  |   2 +-
 .../routines/checkdigit/EAN13CheckDigit.java   |   6 +-
 .../routines/checkdigit/ECNumberCheckDigit.java|   4 +-
 .../routines/checkdigit/IBANCheckDigit.java|   4 +-
 .../routines/checkdigit/ISBN10CheckDigit.java  |   4 +-
 .../routines/checkdigit/ISINCheckDigit.java|   4 +-
 .../routines/checkdigit/LuhnCheckDigit.java|   6 +-
 .../routines/checkdigit/ModulusCheckDigit.java |   8 +-
 .../routines/checkdigit/ModulusTenCheckDigit.java  |  14 +-
 .../routines/checkdigit/SedolCheckDigit.java   |   4 +-
 .../routines/checkdigit/VerhoeffCheckDigit.java|   4 +-
 .../routines/checkdigit/package-info.java  |   2 +-
 .../commons/validator/routines/package-info.java   | 166 ++---
 34 files changed, 257 insertions(+), 257 deletions(-)

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 804ebf0a..298e9398 100644
--- 
a/src/main/java/org/apache/commons/validator/routines/AbstractCalendarValidator.java
+++ 
b/src/main/java/org/apache/commons/validator/routines/AbstractCalendarValidator.java
@@ -29,7 +29,7 @@ import org.apache.commons.validator.GenericValidator;
 /**
  * Abstract class for Date/Time/Calendar validation.
  *
- * This is a base class for building Date / Time
+ * This is a base class for building Date / Time
  *Validators using format parsing.
  *
  * @since 1.3.0
@@ -49,8 +49,8 @@ public abstract class AbstractCalendarValidator extends 
AbstractFormatValidator
 private final int timeStyle;
 
 /**
- * Constructs an instance with the specified strict,
- * time and date style parameters.
+ * Constructs an instance with the specified strict,
+ * time and date style parameters.
  *
  * @param strict {@code true} if strict
  *Format parsing should be used.
@@ -114,7 +114,7 @@ public abstract class AbstractCalendarValidator extends 
AbstractFormatValidator
  *
  * @param value The Calendar value.
  * @param compare The Calendar to check the value against.
- * @param field The field level to compare to - e.g. specifying
+ * @param field The field level to compare to - e.g. specifying
  *Calendar.MONTH will compare the year and month
  *portions of the calendar.
  * @return Zero if the first value is equal to the second, -1
@@ -192,7 +192,7 @@ public abstract class AbstractCalendarValidator extends 
AbstractFormatValidator
  *
  * @param value The Calendar value.
  * @param compare The Calendar to check the value against.
- * @param field The field level to compare to - e.g. specifying
+ * @param field The field level to compare to - e.g. specifying
  *Calendar.MINUTE will compare the hours and minutes
  *portions of the calendar.
  * @return Zero if the first value is equal to the second, -1
@@ -358,7 +358,7 @@ public abstract class AbstractCalendarValidator extends 
AbstractFormatValidator
 }
 
 /**
- * Returns a DateFormat for the specified pattern
+ 

(commons-validator) branch master updated: Javadoc

2024-03-23 Thread ggregory
This is an automated email from the ASF dual-hosted git repository.

ggregory 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 a80e71fc Javadoc
a80e71fc is described below

commit a80e71fced631d89c9c6ddb9fbd0a2ef913aaa08
Author: Gary Gregory 
AuthorDate: Sat Mar 23 09:51:02 2024 -0400

Javadoc
---
 .../java/org/apache/commons/validator/routines/ISINValidator.java | 8 +---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git 
a/src/main/java/org/apache/commons/validator/routines/ISINValidator.java 
b/src/main/java/org/apache/commons/validator/routines/ISINValidator.java
index 5a812f3d..34487d53 100644
--- a/src/main/java/org/apache/commons/validator/routines/ISINValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/ISINValidator.java
@@ -71,7 +71,8 @@ public class ISINValidator implements Serializable {
 }
 
 /**
- * Gets the singleton instance of the ISIN validator
+ * Gets the singleton instance of the ISIN validator.
+ *
  * @param checkCountryCode whether to check the country-code prefix or not
  * @return A singleton instance of the appropriate ISIN validator.
  */
@@ -93,8 +94,9 @@ public class ISINValidator implements Serializable {
 }
 
 /**
- * Check the code is a valid ISIN code after any transformation
+ * Tests whether the code is a valid ISIN code after any transformation
  * by the validate routine.
+ *
  * @param code The code to validate.
  * @return {@code true} if a valid ISIN
  * code, otherwise {@code false}.
@@ -108,7 +110,7 @@ public class ISINValidator implements Serializable {
 }
 
 /**
- * Check the code is valid ISIN code.
+ * Checks the code is valid ISIN code.
  *
  * @param code The code to validate.
  * @return A valid ISIN code if valid, otherwise {@code null}.



(commons-validator) branch master updated: Javadoc

2024-03-23 Thread ggregory
This is an automated email from the ASF dual-hosted git repository.

ggregory 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 8eb48969 Javadoc
8eb48969 is described below

commit 8eb4896928b49b7f9cac01f98508c4f6e7ad1763
Author: Gary Gregory 
AuthorDate: Sat Mar 23 09:49:30 2024 -0400

Javadoc
---
 .../commons/validator/routines/ISSNValidator.java  | 22 ++
 1 file changed, 14 insertions(+), 8 deletions(-)

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 749da0f4..9d6b41d2 100644
--- a/src/main/java/org/apache/commons/validator/routines/ISSNValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/ISSNValidator.java
@@ -52,6 +52,7 @@ import 
org.apache.commons.validator.routines.checkdigit.ISSNCheckDigit;
  * or trailing spaces before doing the validation.
  * To ensure that only a valid code (without 'ISSN ' prefix) is passed to a 
method,
  * use the following code:
+ * 
  * 
  * Object valid = validator.validate(input);
  * if (valid != null) {
@@ -78,11 +79,11 @@ public class ISSNValidator implements Serializable {
 
 private static final CodeValidator EAN_VALIDATOR = new 
CodeValidator(EAN_ISSN_REGEX, EAN_ISSN_LEN, EAN13CheckDigit.EAN13_CHECK_DIGIT);
 
-/** ISSN Code Validator */
+/** ISSN Code Validator. */
 private static final ISSNValidator ISSN_VALIDATOR = new ISSNValidator();
 
 /**
- * Gets the singleton instance of the ISSN validator
+ * Gets the singleton instance of the ISSN validator.
  *
  * @return A singleton instance of the ISSN validator.
  */
@@ -91,12 +92,13 @@ public class ISSNValidator implements Serializable {
 }
 
 /**
- * Convert an ISSN code to an EAN-13 code.
+ * Converts an ISSN code to an EAN-13 code.
  * 
  * This method requires a valid ISSN code.
  * It may contain a leading 'ISSN ' prefix,
  * as the input is passed through the {@link #validate(String)}
  * method.
+ * 
  *
  * @param issn The ISSN code to convert
  * @param suffix the two digit suffix, e.g. "00"
@@ -128,11 +130,12 @@ public class ISSNValidator implements Serializable {
 }
 
 /**
- * Extract an ISSN code from an ISSN-EAN-13 code.
+ * Extracts an ISSN code from an ISSN-EAN-13 code.
  * 
  * This method requires a valid ISSN-EAN-13 code with NO formatting
  * characters.
- * That is a 13 digit EAN-13 code with the '977' prefix
+ * That is a 13 digit EAN-13 code with the '977' prefix.
+ * 
  *
  * @param ean13 The ISSN code to convert
  * @return A valid ISSN code or {@code null}
@@ -165,8 +168,9 @@ public class ISSNValidator implements Serializable {
 }
 
 /**
- * Check the code is a valid ISSN code after any transformation
+ * Tests whether the code is a valid ISSN code after any transformation
  * by the validate routine.
+ *
  * @param code The code to validate.
  * @return {@code true} if a valid ISSN
  * code, otherwise {@code false}.
@@ -176,10 +180,11 @@ public class ISSNValidator implements Serializable {
 }
 
 /**
- * Check the code is valid ISSN code.
+ * Checks the code is valid ISSN code.
  * 
  * If valid, this method returns the ISSN code with
  * the 'ISSN ' prefix removed (if it was present)
+ * 
  *
  * @param code The code to validate.
  * @return A valid ISSN code if valid, otherwise {@code null}.
@@ -189,9 +194,10 @@ public class ISSNValidator implements Serializable {
 }
 
 /**
- * Check the code is a valid EAN code.
+ * Checks the code is a valid EAN code.
  * 
  * If valid, this method returns the EAN code
+ * 
  *
  * @param code The code to validate.
  * @return A valid EAN code if valid, otherwise {@code null}.



(commons-validator) branch master updated: Javadoc

2024-03-23 Thread ggregory
This is an automated email from the ASF dual-hosted git repository.

ggregory 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 40ada576 Javadoc
40ada576 is described below

commit 40ada576cc8e887ff098f26d955c3145e0c86f18
Author: Gary Gregory 
AuthorDate: Sat Mar 23 09:44:13 2024 -0400

Javadoc
---
 src/test/java/org/apache/commons/validator/ISBNValidatorTest.java   | 2 +-
 .../java/org/apache/commons/validator/routines/IBANValidatorTest.java   | 2 +-
 .../java/org/apache/commons/validator/routines/ISBNValidatorTest.java   | 2 +-
 .../java/org/apache/commons/validator/routines/ISINValidatorTest.java   | 2 +-
 .../java/org/apache/commons/validator/routines/ISSNValidatorTest.java   | 2 +-
 5 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/src/test/java/org/apache/commons/validator/ISBNValidatorTest.java 
b/src/test/java/org/apache/commons/validator/ISBNValidatorTest.java
index 2f06653b..cefd704a 100644
--- a/src/test/java/org/apache/commons/validator/ISBNValidatorTest.java
+++ b/src/test/java/org/apache/commons/validator/ISBNValidatorTest.java
@@ -22,7 +22,7 @@ import static org.junit.jupiter.api.Assertions.assertTrue;
 import org.junit.jupiter.api.Test;
 
 /**
- * ISBNValidator Test Case.
+ * Tests {@link ISBNValidator}.
  *
  * @deprecated to be removed when the 
org.apache.commons.validator.ISBNValidator class is removed
  */
diff --git 
a/src/test/java/org/apache/commons/validator/routines/IBANValidatorTest.java 
b/src/test/java/org/apache/commons/validator/routines/IBANValidatorTest.java
index 9aa93584..e8449886 100644
--- a/src/test/java/org/apache/commons/validator/routines/IBANValidatorTest.java
+++ b/src/test/java/org/apache/commons/validator/routines/IBANValidatorTest.java
@@ -41,7 +41,7 @@ import 
org.apache.commons.validator.routines.checkdigit.IBANCheckDigit;
 import org.junit.jupiter.api.Test;
 
 /**
- * IBANValidator Test Case.
+ * Tests {@link IBANValidator}.
  */
 public class IBANValidatorTest {
 
diff --git 
a/src/test/java/org/apache/commons/validator/routines/ISBNValidatorTest.java 
b/src/test/java/org/apache/commons/validator/routines/ISBNValidatorTest.java
index 9a00cbb3..0a662252 100644
--- a/src/test/java/org/apache/commons/validator/routines/ISBNValidatorTest.java
+++ b/src/test/java/org/apache/commons/validator/routines/ISBNValidatorTest.java
@@ -27,7 +27,7 @@ import java.util.regex.Pattern;
 import org.junit.jupiter.api.Test;
 
 /**
- * ISBNValidator Test Case.
+ * Tests {@link ISBNValidator}.
  */
 public class ISBNValidatorTest {
 
diff --git 
a/src/test/java/org/apache/commons/validator/routines/ISINValidatorTest.java 
b/src/test/java/org/apache/commons/validator/routines/ISINValidatorTest.java
index d384f931..efe8fdd2 100644
--- a/src/test/java/org/apache/commons/validator/routines/ISINValidatorTest.java
+++ b/src/test/java/org/apache/commons/validator/routines/ISINValidatorTest.java
@@ -22,7 +22,7 @@ import static org.junit.jupiter.api.Assertions.assertTrue;
 import org.junit.jupiter.api.Test;
 
 /**
- * ISINValidator Test Case.
+ * Tests {@link ISINValidator}.
  */
 public class ISINValidatorTest {
 
diff --git 
a/src/test/java/org/apache/commons/validator/routines/ISSNValidatorTest.java 
b/src/test/java/org/apache/commons/validator/routines/ISSNValidatorTest.java
index ceffbb06..a0872d4e 100644
--- a/src/test/java/org/apache/commons/validator/routines/ISSNValidatorTest.java
+++ b/src/test/java/org/apache/commons/validator/routines/ISSNValidatorTest.java
@@ -30,7 +30,7 @@ import 
org.apache.commons.validator.routines.checkdigit.EAN13CheckDigit;
 import org.junit.jupiter.api.Test;
 
 /**
- * ISSNValidator Test Case.
+ * Tests {@link ISSNValidator}.
  */
 public class ISSNValidatorTest {
 



(commons-validator) branch master updated: Javadoc

2024-01-17 Thread ggregory
This is an automated email from the ASF dual-hosted git repository.

ggregory 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 0436db2e Javadoc
0436db2e is described below

commit 0436db2e242c31f79e80c6e461cfed853293aed8
Author: Gary Gregory 
AuthorDate: Wed Jan 17 10:24:26 2024 -0500

Javadoc
---
 src/main/java/org/apache/commons/validator/Validator.java | 4 ++--
 src/main/java/org/apache/commons/validator/ValidatorAction.java   | 2 +-
 src/main/java/org/apache/commons/validator/ValidatorResult.java   | 6 +++---
 src/main/java/org/apache/commons/validator/ValidatorResults.java  | 4 ++--
 .../apache/commons/validator/routines/BigDecimalValidator.java| 2 +-
 .../apache/commons/validator/routines/BigIntegerValidator.java| 2 +-
 .../java/org/apache/commons/validator/routines/ByteValidator.java | 2 +-
 .../org/apache/commons/validator/routines/CalendarValidator.java  | 2 +-
 .../java/org/apache/commons/validator/routines/CodeValidator.java | 8 
 .../org/apache/commons/validator/routines/CurrencyValidator.java  | 2 +-
 .../java/org/apache/commons/validator/routines/DateValidator.java | 2 +-
 .../org/apache/commons/validator/routines/DoubleValidator.java| 2 +-
 .../org/apache/commons/validator/routines/FloatValidator.java | 2 +-
 .../java/org/apache/commons/validator/routines/IBANValidator.java | 2 +-
 .../java/org/apache/commons/validator/routines/ISBNValidator.java | 4 ++--
 .../java/org/apache/commons/validator/routines/ISINValidator.java | 2 +-
 .../java/org/apache/commons/validator/routines/ISSNValidator.java | 2 +-
 .../org/apache/commons/validator/routines/IntegerValidator.java   | 2 +-
 .../java/org/apache/commons/validator/routines/LongValidator.java | 2 +-
 .../org/apache/commons/validator/routines/PercentValidator.java   | 2 +-
 .../org/apache/commons/validator/routines/ShortValidator.java | 2 +-
 .../java/org/apache/commons/validator/routines/TimeValidator.java | 2 +-
 .../commons/validator/routines/checkdigit/ModulusCheckDigit.java  | 2 +-
 23 files changed, 31 insertions(+), 31 deletions(-)

diff --git a/src/main/java/org/apache/commons/validator/Validator.java 
b/src/main/java/org/apache/commons/validator/Validator.java
index 262aecd1..7e91b00a 100644
--- a/src/main/java/org/apache/commons/validator/Validator.java
+++ b/src/main/java/org/apache/commons/validator/Validator.java
@@ -201,7 +201,7 @@ public class Validator implements Serializable {
 }
 
 /**
- * Return the class loader to be used for instantiating application objects
+ * Gets the class loader to be used for instantiating application objects
  * when required.  This is determined based upon the following rules:
  * 
  * The class loader set by setClassLoader(), if any
@@ -270,7 +270,7 @@ public class Validator implements Serializable {
 }
 
 /**
- * Return the boolean as to whether the context classloader should be used.
+ * Gets the boolean as to whether the context classloader should be used.
  * @return whether the context classloader should be used.
  */
 public boolean getUseContextClassLoader() {
diff --git a/src/main/java/org/apache/commons/validator/ValidatorAction.java 
b/src/main/java/org/apache/commons/validator/ValidatorAction.java
index b2caa59c..189d995a 100644
--- a/src/main/java/org/apache/commons/validator/ValidatorAction.java
+++ b/src/main/java/org/apache/commons/validator/ValidatorAction.java
@@ -357,7 +357,7 @@ public class ValidatorAction implements Serializable {
 }
 
 /**
- * Return an instance of the validation class or null if the validation 
method is static so does not require an instance to be executed.
+ * Gets an instance of the validation class or null if the validation 
method is static so does not require an instance to be executed.
  */
 private Object getValidationClassInstance() throws ValidatorException {
 if (Modifier.isStatic(this.validationMethod.getModifiers())) {
diff --git a/src/main/java/org/apache/commons/validator/ValidatorResult.java 
b/src/main/java/org/apache/commons/validator/ValidatorResult.java
index 183b6da2..70daa63f 100644
--- a/src/main/java/org/apache/commons/validator/ValidatorResult.java
+++ b/src/main/java/org/apache/commons/validator/ValidatorResult.java
@@ -155,7 +155,7 @@ public class ValidatorResult implements Serializable {
 }
 
 /**
- * Return a Map of the validator actions in this Result.
+ * Gets a Map of the validator actions in this Result.
  * @return Map of validator actions.
  * @deprecated Use getActions() to return the set of actions
  * the isValid(name) and getResult(name) methods
@@ -168,7 +168,7 @@ public class ValidatorResult implements Serializable {
 }
 
 /**
- * Return an Iterator of the action names contained in this Result.
+ * Gets an 

(commons-validator) branch master updated: Javadoc: Use {@code ...}

2024-01-17 Thread ggregory
This is an automated email from the ASF dual-hosted git repository.

ggregory 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 114ce504 Javadoc: Use {@code ...}
114ce504 is described below

commit 114ce5049493ef3464a7bad7b2b8e1db2f654dff
Author: Gary Gregory 
AuthorDate: Wed Jan 17 09:29:47 2024 -0500

Javadoc: Use {@code ...}
---
 .../apache/commons/validator/EmailValidator.java   |  2 +-
 .../java/org/apache/commons/validator/Field.java   |  2 +-
 .../apache/commons/validator/ISBNValidator.java|  2 +-
 .../org/apache/commons/validator/UrlValidator.java |  8 
 .../org/apache/commons/validator/Validator.java|  2 +-
 .../apache/commons/validator/ValidatorAction.java  |  2 +-
 .../routines/AbstractCalendarValidator.java|  8 
 .../routines/AbstractFormatValidator.java  |  6 +++---
 .../routines/AbstractNumberValidator.java  | 10 -
 .../validator/routines/BigDecimalValidator.java| 12 +--
 .../validator/routines/BigIntegerValidator.java| 10 -
 .../commons/validator/routines/ByteValidator.java  | 12 +--
 .../validator/routines/CalendarValidator.java  | 20 +-
 .../commons/validator/routines/CodeValidator.java  |  4 ++--
 .../validator/routines/CreditCardValidator.java|  2 +-
 .../validator/routines/CurrencyValidator.java  |  2 +-
 .../commons/validator/routines/DateValidator.java  | 24 +++---
 .../validator/routines/DoubleValidator.java| 12 +--
 .../commons/validator/routines/EmailValidator.java |  2 +-
 .../commons/validator/routines/FloatValidator.java | 12 +--
 .../commons/validator/routines/ISBNValidator.java  | 10 -
 .../commons/validator/routines/ISINValidator.java  |  2 +-
 .../commons/validator/routines/ISSNValidator.java  |  8 
 .../validator/routines/IntegerValidator.java   | 12 +--
 .../commons/validator/routines/LongValidator.java  | 10 -
 .../validator/routines/PercentValidator.java   |  2 +-
 .../commons/validator/routines/RegexValidator.java |  4 ++--
 .../commons/validator/routines/ShortValidator.java | 12 +--
 .../commons/validator/routines/TimeValidator.java  | 20 +-
 .../commons/validator/routines/UrlValidator.java   |  8 
 .../commons/validator/routines/package-info.java   |  4 ++--
 .../commons/validator/util/ValidatorUtils.java |  2 +-
 .../commons/validator/GenericValidatorImpl.java|  2 +-
 .../apache/commons/validator/ValidatorTest.java|  4 ++--
 34 files changed, 127 insertions(+), 127 deletions(-)

diff --git a/src/main/java/org/apache/commons/validator/EmailValidator.java 
b/src/main/java/org/apache/commons/validator/EmailValidator.java
index 4c9e57c5..55a29138 100644
--- a/src/main/java/org/apache/commons/validator/EmailValidator.java
+++ b/src/main/java/org/apache/commons/validator/EmailValidator.java
@@ -80,7 +80,7 @@ public class EmailValidator {
 /**
  * Checks if a field has a valid e-mail address.
  *
- * @param email The value validation is being performed on.  A 
null
+ * @param email The value validation is being performed on.  A {@code null}
  * value is considered invalid.
  * @return true if the email address is valid.
  */
diff --git a/src/main/java/org/apache/commons/validator/Field.java 
b/src/main/java/org/apache/commons/validator/Field.java
index 800ff784..cf10b809 100644
--- a/src/main/java/org/apache/commons/validator/Field.java
+++ b/src/main/java/org/apache/commons/validator/Field.java
@@ -313,7 +313,7 @@ public class Field implements Cloneable, Serializable {
 
 /**
  * Gets the Arg object at the given position.  If the key
- * finds a null value then the default value will be
+ * finds a {@code null} value then the default value will be
  * retrieved.
  * @param key The name the Arg is stored under.  If not found, the default
  * Arg for the given position (if any) will be retrieved.
diff --git a/src/main/java/org/apache/commons/validator/ISBNValidator.java 
b/src/main/java/org/apache/commons/validator/ISBNValidator.java
index 5cfeec44..665cd3b5 100644
--- a/src/main/java/org/apache/commons/validator/ISBNValidator.java
+++ b/src/main/java/org/apache/commons/validator/ISBNValidator.java
@@ -43,7 +43,7 @@ public class ISBNValidator {
  * divided by 11 according to the ISBN algorithm.  If the result is zero,
  * the ISBN is valid.  This method accepts formatted or raw ISBN codes.
  *
- * @param isbn Candidate ISBN number to be validated. null is
+ * @param isbn Candidate ISBN number to be validated. {@code null} is
  * considered invalid.
  * @return true if the string is a valid ISBN code.
  */
diff --git a/src/main/java/org/apache/commons/validator/UrlValidator.java 

(commons-validator) branch master updated: Javadoc and comments: Use an HTTPS URL

2024-01-14 Thread ggregory
This is an automated email from the ASF dual-hosted git repository.

ggregory 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 b9cf5216 Javadoc and comments: Use an HTTPS URL
b9cf5216 is described below

commit b9cf5216eaee880e2251b309eeaeafd7d3fd3da9
Author: Gary Gregory 
AuthorDate: Sun Jan 14 11:18:38 2024 -0500

Javadoc and comments: Use an HTTPS URL
---
 .../java/org/apache/commons/validator/routines/DomainValidatorTest.java | 2 +-
 .../java/org/apache/commons/validator/routines/EmailValidatorTest.java  | 2 +-
 .../org/apache/commons/validator/routines/InetAddressValidatorTest.java | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)

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 af485308..2665c79c 100644
--- 
a/src/test/java/org/apache/commons/validator/routines/DomainValidatorTest.java
+++ 
b/src/test/java/org/apache/commons/validator/routines/DomainValidatorTest.java
@@ -258,7 +258,7 @@ public class DomainValidatorTest {
 return sorted && strictlySorted && lowerCase;
 }
 
-// Download and process local copy of 
http://data.iana.org/TLD/tlds-alpha-by-domain.txt
+// Download and process local copy of 
https://data.iana.org/TLD/tlds-alpha-by-domain.txt
 // Check if the internal TLD table is up to date
 // Check if the internal TLD tables have any spurious entries
 public static void main(final String a[]) throws Exception {
diff --git 
a/src/test/java/org/apache/commons/validator/routines/EmailValidatorTest.java 
b/src/test/java/org/apache/commons/validator/routines/EmailValidatorTest.java
index 61aeab50..44194dde 100644
--- 
a/src/test/java/org/apache/commons/validator/routines/EmailValidatorTest.java
+++ 
b/src/test/java/org/apache/commons/validator/routines/EmailValidatorTest.java
@@ -149,7 +149,7 @@ public class EmailValidatorTest {
 /**
  * Tests the e-mail validation with a user at a TLD
  *
- * http://tools.ietf.org/html/rfc5321#section-2.3.5 (In the case of a 
top-level domain used by itself in an email address, a single string is used 
without
+ * https://tools.ietf.org/html/rfc5321#section-2.3.5 (In the case of a 
top-level domain used by itself in an email address, a single string is used 
without
  * any dots)
  */
 @Test
diff --git 
a/src/test/java/org/apache/commons/validator/routines/InetAddressValidatorTest.java
 
b/src/test/java/org/apache/commons/validator/routines/InetAddressValidatorTest.java
index 2a2e0bce..86ebd165 100644
--- 
a/src/test/java/org/apache/commons/validator/routines/InetAddressValidatorTest.java
+++ 
b/src/test/java/org/apache/commons/validator/routines/InetAddressValidatorTest.java
@@ -84,7 +84,7 @@ public class InetAddressValidatorTest {
 /**
  * Test IPv6 addresses.
  * 
- * These tests were ported from a http://download.dartware.com/thirdparty/test-ipv6-regex.pl;>Perl 
script.
+ * These tests were ported from a https://download.dartware.com/thirdparty/test-ipv6-regex.pl;>Perl 
script.
  * 
  *
  */



(commons-validator) branch master updated: Javadoc and comments: Use an HTTPS URL

2024-01-14 Thread ggregory
This is an automated email from the ASF dual-hosted git repository.

ggregory 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 f0a77b0b Javadoc and comments: Use an HTTPS URL
f0a77b0b is described below

commit f0a77b0b1626c7b6a694e13ba28a9305090e7014
Author: Gary Gregory 
AuthorDate: Sun Jan 14 11:17:51 2024 -0500

Javadoc and comments: Use an HTTPS URL
---
 src/main/java/org/apache/commons/validator/EmailValidator.java  | 2 +-
 src/main/java/org/apache/commons/validator/GenericValidator.java| 2 +-
 src/main/java/org/apache/commons/validator/UrlValidator.java| 2 +-
 .../java/org/apache/commons/validator/routines/DomainValidator.java | 2 +-
 .../java/org/apache/commons/validator/routines/EmailValidator.java  | 2 +-
 .../java/org/apache/commons/validator/routines/ISBNValidator.java   | 6 +++---
 .../java/org/apache/commons/validator/routines/ISINValidator.java   | 2 +-
 .../java/org/apache/commons/validator/routines/UrlValidator.java| 4 ++--
 .../commons/validator/routines/checkdigit/ABANumberCheckDigit.java  | 2 +-
 .../commons/validator/routines/checkdigit/CUSIPCheckDigit.java  | 2 +-
 .../commons/validator/routines/checkdigit/EAN13CheckDigit.java  | 6 +++---
 .../commons/validator/routines/checkdigit/IBANCheckDigit.java   | 2 +-
 .../commons/validator/routines/checkdigit/ISBN10CheckDigit.java | 2 +-
 .../commons/validator/routines/checkdigit/ISINCheckDigit.java   | 2 +-
 .../commons/validator/routines/checkdigit/LuhnCheckDigit.java   | 6 +++---
 .../commons/validator/routines/checkdigit/SedolCheckDigit.java  | 2 +-
 .../commons/validator/routines/checkdigit/VerhoeffCheckDigit.java   | 4 ++--
 17 files changed, 25 insertions(+), 25 deletions(-)

diff --git a/src/main/java/org/apache/commons/validator/EmailValidator.java 
b/src/main/java/org/apache/commons/validator/EmailValidator.java
index 286eae87..4c9e57c5 100644
--- a/src/main/java/org/apache/commons/validator/EmailValidator.java
+++ b/src/main/java/org/apache/commons/validator/EmailValidator.java
@@ -28,7 +28,7 @@ import 
org.apache.commons.validator.routines.InetAddressValidator;
  * 
  * 
  * Based on a script by mailto:stamhan...@hotmail.com;>Sandeep V. 
Tamhankar
- * http://javascript.internet.com
+ * https://javascript.internet.com
  * 
  * 
  * This implementation is not guaranteed to catch all possible errors in an 
email address.
diff --git a/src/main/java/org/apache/commons/validator/GenericValidator.java 
b/src/main/java/org/apache/commons/validator/GenericValidator.java
index 91c90143..6589bfef 100644
--- a/src/main/java/org/apache/commons/validator/GenericValidator.java
+++ b/src/main/java/org/apache/commons/validator/GenericValidator.java
@@ -338,7 +338,7 @@ public class GenericValidator implements Serializable {
 return value <= max;
 }
 
-// See http://issues.apache.org/bugzilla/show_bug.cgi?id=29015 WRT the 
"value" methods
+// See https://issues.apache.org/bugzilla/show_bug.cgi?id=29015 WRT the 
"value" methods
 
 /**
  * Checks if the value is less than or equal to the max.
diff --git a/src/main/java/org/apache/commons/validator/UrlValidator.java 
b/src/main/java/org/apache/commons/validator/UrlValidator.java
index 823f3337..a2b464ee 100644
--- a/src/main/java/org/apache/commons/validator/UrlValidator.java
+++ b/src/main/java/org/apache/commons/validator/UrlValidator.java
@@ -39,7 +39,7 @@ import org.apache.commons.validator.util.Flags;
  * 
  *
  * Originally based in on php script by Debbie Dyer, validation.php v1.2b, 
Date: 03/07/02,
- * http://javascript.internet.com. However, this validation now bears little 
resemblance
+ * https://javascript.internet.com. However, this validation now bears little 
resemblance
  * to the php original.
  * 
  *   Example of usage:
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 f8ec0952..45979871 100644
--- a/src/main/java/org/apache/commons/validator/routines/DomainValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/DomainValidator.java
@@ -2027,7 +2027,7 @@ public class DomainValidator implements Serializable {
 // -
 // - TLDs defined by IANA
 // - Authoritative and comprehensive list at:
-// - http://data.iana.org/TLD/tlds-alpha-by-domain.txt
+// - https://data.iana.org/TLD/tlds-alpha-by-domain.txt
 
 // Note that the above list is in UPPER case.
 // The code currently converts strings to lower case (as per the tables 
below)
diff --git 
a/src/main/java/org/apache/commons/validator/routines/EmailValidator.java 
b/src/main/java/org/apache/commons/validator/routines/EmailValidator.java
index 668fe642..3cf1f7c1 100644
--- 

(commons-validator) branch master updated: Javadoc: Use an HTTPS URL to the Apache web site

2024-01-14 Thread ggregory
This is an automated email from the ASF dual-hosted git repository.

ggregory 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 de67a89b Javadoc: Use an HTTPS URL to the Apache web site
de67a89b is described below

commit de67a89b3d7559eebc976ca390595d63099b9965
Author: Gary Gregory 
AuthorDate: Sun Jan 14 10:32:59 2024 -0500

Javadoc: Use an HTTPS URL to the Apache web site
---
 src/main/java/org/apache/commons/validator/package-info.java | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/src/main/java/org/apache/commons/validator/package-info.java 
b/src/main/java/org/apache/commons/validator/package-info.java
index 482d8fb0..10373b1e 100644
--- a/src/main/java/org/apache/commons/validator/package-info.java
+++ b/src/main/java/org/apache/commons/validator/package-info.java
@@ -20,7 +20,7 @@
  *
  * 
  * 
- * http://commons.apache.org/validator/dependencies.html;>[Dependencies]
+ * https://commons.apache.org/validator/dependencies.html;>[Dependencies]
  * [Introduction]
  * [Overview]
  * [Resources]
@@ -66,7 +66,7 @@
  * them abstracted from JavaBean you are validating.  The
  * property reference to a field supports nested properties
  * using the Apache Commons BeanUtils
- * (http://commons.apache.org/beanutils/) package.
+ * (https://commons.apache.org/beanutils/) package.
  * Error messages and the arguments for error messages can be
  * associated with a fields validation.
  * 



(commons-validator) branch master updated: Javadoc

2023-12-17 Thread ggregory
This is an automated email from the ASF dual-hosted git repository.

ggregory 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 2896eeef Javadoc
 new 8f4a0d60 Merge branch 'master' of 
https://gitbox.apache.org/repos/asf/commons-validator
2896eeef is described below

commit 2896eeefb02e1f78fcaa889079f20be1278702e4
Author: Gary Gregory 
AuthorDate: Sun Dec 17 14:41:38 2023 -0500

Javadoc
---
 src/main/java/org/apache/commons/validator/GenericTypeValidator.java | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git 
a/src/main/java/org/apache/commons/validator/GenericTypeValidator.java 
b/src/main/java/org/apache/commons/validator/GenericTypeValidator.java
index 7d5d7d26..900fb96a 100644
--- a/src/main/java/org/apache/commons/validator/GenericTypeValidator.java
+++ b/src/main/java/org/apache/commons/validator/GenericTypeValidator.java
@@ -106,7 +106,7 @@ public class GenericTypeValidator implements Serializable {
 /**
  * Checks if the field is a valid date.
  *
- * The {@code Locale} is used with {@code java.text.DateFormat}. The 
{@link java.text.DateFormat#setLenient(boolean)}
+ * The {@code Locale} is used with {@link java.text.DateFormat}. The 
{@link java.text.DateFormat#setLenient(boolean)}
  * method is set to {@code false} for all.
  * 
  *
@@ -166,7 +166,7 @@ public class GenericTypeValidator implements Serializable {
 /**
  * Checks if the field is a valid date.
  *
- * The pattern is used with {@code java.text.SimpleDateFormat}.
+ * The pattern is used with {@link java.text.SimpleDateFormat}.
  * If strict is true, then the length will be checked so '2/12/1999' will
  * not pass validation with the format 'MM/dd/' because the month isn't
  * two digits. The {@link java.text.SimpleDateFormat#setLenient(boolean)}



(commons-validator) branch master updated: Javadoc

2023-12-14 Thread ggregory
This is an automated email from the ASF dual-hosted git repository.

ggregory 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 59b2caea Javadoc
59b2caea is described below

commit 59b2caeaaa71a292a646873287eae4e2773b47a7
Author: Gary Gregory 
AuthorDate: Thu Dec 14 14:04:36 2023 -0500

Javadoc
---
 .../commons/validator/routines/checkdigit/ABANumberCheckDigit.java| 2 +-
 .../apache/commons/validator/routines/checkdigit/CUSIPCheckDigit.java | 2 +-
 .../apache/commons/validator/routines/checkdigit/EAN13CheckDigit.java | 2 +-
 .../apache/commons/validator/routines/checkdigit/ISINCheckDigit.java  | 2 +-
 .../apache/commons/validator/routines/checkdigit/LuhnCheckDigit.java  | 2 +-
 .../apache/commons/validator/routines/checkdigit/SedolCheckDigit.java | 2 +-
 .../commons/validator/routines/checkdigit/VerhoeffCheckDigit.java | 2 +-
 .../commons/validator/routines/checkdigit/AbstractCheckDigitTest.java | 4 ++--
 8 files changed, 9 insertions(+), 9 deletions(-)

diff --git 
a/src/main/java/org/apache/commons/validator/routines/checkdigit/ABANumberCheckDigit.java
 
b/src/main/java/org/apache/commons/validator/routines/checkdigit/ABANumberCheckDigit.java
index 6649c1a0..578d13c2 100644
--- 
a/src/main/java/org/apache/commons/validator/routines/checkdigit/ABANumberCheckDigit.java
+++ 
b/src/main/java/org/apache/commons/validator/routines/checkdigit/ABANumberCheckDigit.java
@@ -50,7 +50,7 @@ public final class ABANumberCheckDigit extends 
ModulusCheckDigit {
 /** Singleton Routing Transit Number Check Digit instance */
 public static final CheckDigit ABAN_CHECK_DIGIT = new 
ABANumberCheckDigit();
 
-/** weighting given to digits depending on their right position */
+/** Weighting given to digits depending on their right position */
 private static final int[] POSITION_WEIGHT = {3, 1, 7};
 
 /**
diff --git 
a/src/main/java/org/apache/commons/validator/routines/checkdigit/CUSIPCheckDigit.java
 
b/src/main/java/org/apache/commons/validator/routines/checkdigit/CUSIPCheckDigit.java
index e2f054a6..72b3af3f 100644
--- 
a/src/main/java/org/apache/commons/validator/routines/checkdigit/CUSIPCheckDigit.java
+++ 
b/src/main/java/org/apache/commons/validator/routines/checkdigit/CUSIPCheckDigit.java
@@ -45,7 +45,7 @@ public final class CUSIPCheckDigit extends ModulusCheckDigit {
 /** Singleton CUSIP Check Digit instance */
 public static final CheckDigit CUSIP_CHECK_DIGIT = new CUSIPCheckDigit();
 
-/** weighting given to digits depending on their right position */
+/** Weighting given to digits depending on their right position */
 private static final int[] POSITION_WEIGHT = {2, 1};
 
 /**
diff --git 
a/src/main/java/org/apache/commons/validator/routines/checkdigit/EAN13CheckDigit.java
 
b/src/main/java/org/apache/commons/validator/routines/checkdigit/EAN13CheckDigit.java
index f1bd3ab1..78e84d1b 100644
--- 
a/src/main/java/org/apache/commons/validator/routines/checkdigit/EAN13CheckDigit.java
+++ 
b/src/main/java/org/apache/commons/validator/routines/checkdigit/EAN13CheckDigit.java
@@ -46,7 +46,7 @@ public final class EAN13CheckDigit extends ModulusCheckDigit {
 /** Singleton EAN-13 Check Digit instance */
 public static final CheckDigit EAN13_CHECK_DIGIT = new EAN13CheckDigit();
 
-/** weighting given to digits depending on their right position */
+/** Weighting given to digits depending on their right position */
 private static final int[] POSITION_WEIGHT = {3, 1};
 
 /**
diff --git 
a/src/main/java/org/apache/commons/validator/routines/checkdigit/ISINCheckDigit.java
 
b/src/main/java/org/apache/commons/validator/routines/checkdigit/ISINCheckDigit.java
index 88931f63..b43c0f9b 100644
--- 
a/src/main/java/org/apache/commons/validator/routines/checkdigit/ISINCheckDigit.java
+++ 
b/src/main/java/org/apache/commons/validator/routines/checkdigit/ISINCheckDigit.java
@@ -47,7 +47,7 @@ public final class ISINCheckDigit extends ModulusCheckDigit {
 /** Singleton ISIN Check Digit instance */
 public static final CheckDigit ISIN_CHECK_DIGIT = new ISINCheckDigit();
 
-/** weighting given to digits depending on their right position */
+/** Weighting given to digits depending on their right position */
 private static final int[] POSITION_WEIGHT = {2, 1};
 
 /**
diff --git 
a/src/main/java/org/apache/commons/validator/routines/checkdigit/LuhnCheckDigit.java
 
b/src/main/java/org/apache/commons/validator/routines/checkdigit/LuhnCheckDigit.java
index caa2525e..866223d8 100644
--- 
a/src/main/java/org/apache/commons/validator/routines/checkdigit/LuhnCheckDigit.java
+++ 
b/src/main/java/org/apache/commons/validator/routines/checkdigit/LuhnCheckDigit.java
@@ -43,7 +43,7 @@ public final class LuhnCheckDigit extends ModulusCheckDigit {
 /** Singleton Luhn Check Digit instance */
 public static 

(commons-validator) branch master updated: Javadoc

2023-12-01 Thread ggregory
This is an automated email from the ASF dual-hosted git repository.

ggregory 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 05cd89b4 Javadoc
05cd89b4 is described below

commit 05cd89b453e4db2712daa21b51a7d1aeccf1f54b
Author: Gary Gregory 
AuthorDate: Fri Dec 1 09:35:53 2023 -0500

Javadoc
---
 .../apache/commons/validator/routines/checkdigit/ModulusCheckDigit.java | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git 
a/src/main/java/org/apache/commons/validator/routines/checkdigit/ModulusCheckDigit.java
 
b/src/main/java/org/apache/commons/validator/routines/checkdigit/ModulusCheckDigit.java
index b52a44a1..2e15953b 100644
--- 
a/src/main/java/org/apache/commons/validator/routines/checkdigit/ModulusCheckDigit.java
+++ 
b/src/main/java/org/apache/commons/validator/routines/checkdigit/ModulusCheckDigit.java
@@ -51,7 +51,7 @@ public abstract class ModulusCheckDigit implements 
CheckDigit, Serializable {
 }
 
 /**
- * The modulus can be > 10 provided that the implementing class overrides 
toCheckDigit and toInt (for example as in ISBN10CheckDigit).
+ * The modulus can be greater than 10 provided that the implementing class 
overrides toCheckDigit and toInt (for example as in ISBN10CheckDigit).
  */
 private final int modulus;
 



(commons-validator) branch master updated: Javadoc spelling

2023-11-26 Thread ggregory
This is an automated email from the ASF dual-hosted git repository.

ggregory 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 1db93b48 Javadoc spelling
1db93b48 is described below

commit 1db93b48f3cba45d4ddc132a615c686b247b56fd
Author: Gary Gregory 
AuthorDate: Sun Nov 26 15:58:22 2023 -0500

Javadoc spelling
---
 src/main/java/org/apache/commons/validator/ValidatorAction.java | 8 
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/src/main/java/org/apache/commons/validator/ValidatorAction.java 
b/src/main/java/org/apache/commons/validator/ValidatorAction.java
index 344c1f95..9a577ec8 100644
--- a/src/main/java/org/apache/commons/validator/ValidatorAction.java
+++ b/src/main/java/org/apache/commons/validator/ValidatorAction.java
@@ -129,12 +129,12 @@ public class ValidatorAction implements Serializable {
 
 /**
  * An optional field to containing a JavaScript representation of the
- * java method assocated with this action.
+ * Java method assocated with this action.
  */
 private String javascript;
 
 /**
- * If the java method matching the correct signature isn't static, the
+ * If the Java method matching the correct signature isn't static, the
  * instance is stored in the action.  This assumes the method is thread
  * safe.
  */
@@ -340,7 +340,7 @@ public class ValidatorAction implements Serializable {
 }
 
 /**
- * Gets the Javascript equivalent of the java class and method
+ * Gets the Javascript equivalent of the Java class and method
  * associated with this action.
  * @return The Javascript validation.
  */
@@ -349,7 +349,7 @@ public class ValidatorAction implements Serializable {
 }
 
 /**
- * Sets the Javascript equivalent of the java class and method
+ * Sets the Javascript equivalent of the Java class and method
  * associated with this action.
  * @param javascript The Javascript validation.
  */



(commons-validator) branch master updated: Javadoc

2023-11-11 Thread ggregory
This is an automated email from the ASF dual-hosted git repository.

ggregory 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 5ef3bba8 Javadoc
5ef3bba8 is described below

commit 5ef3bba88e1b52de5d0a133cd1b3fbeaa60f7861
Author: Gary Gregory 
AuthorDate: Sat Nov 11 16:16:55 2023 -0500

Javadoc
---
 src/main/java/org/apache/commons/validator/Validator.java|  6 +++---
 .../java/org/apache/commons/validator/ValidatorResult.java   |  2 +-
 .../validator/routines/AbstractCalendarValidator.java|  2 +-
 .../commons/validator/routines/AbstractFormatValidator.java  |  2 +-
 .../commons/validator/routines/AbstractNumberValidator.java  |  2 +-
 .../commons/validator/routines/BigDecimalValidator.java  |  2 +-
 .../commons/validator/routines/BigIntegerValidator.java  |  2 +-
 .../org/apache/commons/validator/routines/ByteValidator.java |  2 +-
 .../apache/commons/validator/routines/CalendarValidator.java |  4 ++--
 .../org/apache/commons/validator/routines/CodeValidator.java | 12 ++--
 .../apache/commons/validator/routines/CurrencyValidator.java |  4 ++--
 .../org/apache/commons/validator/routines/DateValidator.java |  4 ++--
 .../apache/commons/validator/routines/DoubleValidator.java   |  2 +-
 .../apache/commons/validator/routines/FloatValidator.java|  2 +-
 .../org/apache/commons/validator/routines/ISBNValidator.java |  4 ++--
 .../apache/commons/validator/routines/IntegerValidator.java  |  2 +-
 .../org/apache/commons/validator/routines/LongValidator.java |  2 +-
 .../apache/commons/validator/routines/PercentValidator.java  |  4 ++--
 .../apache/commons/validator/routines/RegexValidator.java|  2 +-
 .../apache/commons/validator/routines/ShortValidator.java|  2 +-
 .../org/apache/commons/validator/routines/TimeValidator.java |  4 ++--
 .../validator/routines/checkdigit/ABANumberCheckDigit.java   |  2 +-
 .../validator/routines/checkdigit/CUSIPCheckDigit.java   |  2 +-
 .../validator/routines/checkdigit/CheckDigitException.java   |  6 +++---
 .../validator/routines/checkdigit/EAN13CheckDigit.java   |  2 +-
 .../validator/routines/checkdigit/IBANCheckDigit.java|  2 +-
 .../validator/routines/checkdigit/ISBN10CheckDigit.java  |  2 +-
 .../validator/routines/checkdigit/ISINCheckDigit.java|  2 +-
 .../validator/routines/checkdigit/LuhnCheckDigit.java|  2 +-
 .../validator/routines/checkdigit/ModulusCheckDigit.java |  2 +-
 .../validator/routines/checkdigit/ModulusTenCheckDigit.java  |  6 +++---
 .../validator/routines/checkdigit/SedolCheckDigit.java   |  2 +-
 .../commons/validator/CustomValidatorResourcesTest.java  |  2 +-
 .../apache/commons/validator/routines/CodeValidatorTest.java |  2 +-
 .../validator/routines/checkdigit/CUSIPCheckDigitTest.java   |  2 +-
 .../routines/checkdigit/ModulusTenCUSIPCheckDigitTest.java   |  2 +-
 .../routines/checkdigit/VerhoeffCheckDigitTest.java  |  2 +-
 37 files changed, 54 insertions(+), 54 deletions(-)

diff --git a/src/main/java/org/apache/commons/validator/Validator.java 
b/src/main/java/org/apache/commons/validator/Validator.java
index de946431..cc1dcf25 100644
--- a/src/main/java/org/apache/commons/validator/Validator.java
+++ b/src/main/java/org/apache/commons/validator/Validator.java
@@ -134,7 +134,7 @@ public class Validator implements Serializable {
 protected boolean onlyReturnErrors;
 
 /**
- * Construct a Validator that will
+ * Constructs a Validator that will
  * use the ValidatorResources
  * passed in to retrieve pluggable validators
  * the different sets of validation rules.
@@ -146,7 +146,7 @@ public class Validator implements Serializable {
 }
 
 /**
- * Construct a Validator that will
+ * Constructs a Validator that will
  * use the ValidatorResources
  * passed in to retrieve pluggable validators
  * the different sets of validation rules.
@@ -164,7 +164,7 @@ public class Validator implements Serializable {
 }
 
 /**
- * Construct a Validator that will
+ * Constructs a Validator that will
  * use the ValidatorResources
  * passed in to retrieve pluggable validators
  * the different sets of validation rules.
diff --git a/src/main/java/org/apache/commons/validator/ValidatorResult.java 
b/src/main/java/org/apache/commons/validator/ValidatorResult.java
index f3ca9bda..56ee0173 100644
--- a/src/main/java/org/apache/commons/validator/ValidatorResult.java
+++ b/src/main/java/org/apache/commons/validator/ValidatorResult.java
@@ -140,7 +140,7 @@ public class ValidatorResult implements Serializable {
 private Object result;
 
/**
-* Construct a Result status.
+* Constructs a Result status.
 * @param valid Whether the validator passed or failed.
 * @param result Value returned by the validator.
 */

[commons-validator] branch master updated: Javadoc

2023-10-19 Thread ggregory
This is an automated email from the ASF dual-hosted git repository.

ggregory 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 5dee4842 Javadoc
5dee4842 is described below

commit 5dee4842f1e4e63bd10b98f26811107c310879af
Author: Gary Gregory 
AuthorDate: Thu Oct 19 08:39:14 2023 -0400

Javadoc
---
 src/main/java/org/apache/commons/validator/ValidatorAction.java | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/main/java/org/apache/commons/validator/ValidatorAction.java 
b/src/main/java/org/apache/commons/validator/ValidatorAction.java
index d7e78208..344c1f95 100644
--- a/src/main/java/org/apache/commons/validator/ValidatorAction.java
+++ b/src/main/java/org/apache/commons/validator/ValidatorAction.java
@@ -452,7 +452,7 @@ public class ValidatorAction implements Serializable {
 }
 
 /**
- * @return A filename suitable for passing to a
+ * @return A file name suitable for passing to a
  * ClassLoader.getResourceAsStream() method.
  */
 private String formatJavascriptFileName() {



[commons-validator] branch master updated: Javadoc: Upper case acronym

2023-10-17 Thread ggregory
This is an automated email from the ASF dual-hosted git repository.

ggregory 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 595c60f3 Javadoc: Upper case acronym
595c60f3 is described below

commit 595c60f3a76cd3f078d850eb7eb8b3cd7a32936c
Author: Gary Gregory 
AuthorDate: Tue Oct 17 08:49:20 2023 -0400

Javadoc: Upper case acronym
---
 src/test/java/org/apache/commons/validator/EmailTest.java | 4 ++--
 .../org/apache/commons/validator/routines/EmailValidatorTest.java | 4 ++--
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/src/test/java/org/apache/commons/validator/EmailTest.java 
b/src/test/java/org/apache/commons/validator/EmailTest.java
index b927575e..31260498 100644
--- a/src/test/java/org/apache/commons/validator/EmailTest.java
+++ b/src/test/java/org/apache/commons/validator/EmailTest.java
@@ -202,8 +202,8 @@ protected void setUp() throws IOException, SAXException {
 }
 
/**
-* Tests the email validation with ascii control characters.
-* (i.e. Ascii chars 0 - 31 and 127)
+* Tests the email validation with ASCII control characters.
+* (i.e. ASCII chars 0 - 31 and 127)
 */
 public void testEmailWithControlChars() {
 final EmailValidator validator = new EmailValidator();
diff --git 
a/src/test/java/org/apache/commons/validator/routines/EmailValidatorTest.java 
b/src/test/java/org/apache/commons/validator/routines/EmailValidatorTest.java
index b0ebd230..faf6e680 100644
--- 
a/src/test/java/org/apache/commons/validator/routines/EmailValidatorTest.java
+++ 
b/src/test/java/org/apache/commons/validator/routines/EmailValidatorTest.java
@@ -211,8 +211,8 @@ public class EmailValidatorTest {
 }
 
/**
-* Tests the email validation with ascii control characters.
-* (i.e. Ascii chars 0 - 31 and 127)
+* Tests the email validation with ASCII control characters.
+* (i.e. ASCII chars 0 - 31 and 127)
 */
 @Test
 public void testEmailWithControlChars()  {



[commons-validator] branch master updated: Javadoc typos #144

2023-08-02 Thread ggregory
This is an automated email from the ASF dual-hosted git repository.

ggregory 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 1b937be4 Javadoc typos #144
1b937be4 is described below

commit 1b937be4d7b654f84014944911cabcb34d632efe
Author: Gary Gregory 
AuthorDate: Wed Aug 2 08:39:22 2023 -0400

Javadoc typos #144
---
 src/changes/changes.xml | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 4510a1b9..47ae9ffc 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -78,6 +78,9 @@ The  type attribute can be add,update,fix,remove.
 
   [StepSecurity] ci: Harden GitHub Actions #136.
 
+
+  Javadoc typos #144.
+
 
 
   Add github/codeql-action.



[commons-validator] branch master updated: Javadoc: Use {@code } instead of HTML tags.

2023-04-28 Thread ggregory
This is an automated email from the ASF dual-hosted git repository.

ggregory 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 35f43a63 Javadoc: Use {@code } instead of HTML tags.
35f43a63 is described below

commit 35f43a63bd1689961ada7fcea4d3cab81747b5d7
Author: Gary Gregory 
AuthorDate: Fri Apr 28 15:11:47 2023 -0400

Javadoc: Use {@code } instead of HTML tags.
---
 .../java/org/apache/commons/validator/Arg.java |  2 +-
 .../apache/commons/validator/DateValidator.java|  4 +-
 .../java/org/apache/commons/validator/Field.java   |  8 ++--
 .../apache/commons/validator/GenericValidator.java |  4 +-
 .../java/org/apache/commons/validator/Msg.java |  2 +-
 .../org/apache/commons/validator/Validator.java|  2 +-
 .../apache/commons/validator/ValidatorAction.java  |  4 +-
 .../apache/commons/validator/ValidatorResults.java |  4 +-
 .../java/org/apache/commons/validator/Var.java |  2 +-
 .../routines/AbstractCalendarValidator.java|  4 +-
 .../routines/AbstractFormatValidator.java  | 16 +++
 .../routines/AbstractNumberValidator.java  | 18 +++
 .../validator/routines/BigDecimalValidator.java| 14 +++---
 .../validator/routines/BigIntegerValidator.java|  8 ++--
 .../commons/validator/routines/ByteValidator.java  | 14 +++---
 .../validator/routines/CalendarValidator.java  |  2 +-
 .../commons/validator/routines/CodeValidator.java  |  8 ++--
 .../validator/routines/CurrencyValidator.java  |  6 +--
 .../commons/validator/routines/DateValidator.java  |  2 +-
 .../validator/routines/DoubleValidator.java| 14 +++---
 .../commons/validator/routines/FloatValidator.java | 14 +++---
 .../commons/validator/routines/IBANValidator.java  |  2 +-
 .../commons/validator/routines/ISBNValidator.java  | 24 +-
 .../commons/validator/routines/ISINValidator.java  |  4 +-
 .../commons/validator/routines/ISSNValidator.java  |  4 +-
 .../validator/routines/IntegerValidator.java   | 14 +++---
 .../commons/validator/routines/LongValidator.java  | 14 +++---
 .../validator/routines/PercentValidator.java   |  2 +-
 .../commons/validator/routines/RegexValidator.java | 10 ++--
 .../commons/validator/routines/ShortValidator.java | 14 +++---
 .../commons/validator/routines/TimeValidator.java  |  2 +-
 .../validator/routines/checkdigit/CheckDigit.java  |  4 +-
 .../routines/checkdigit/IBANCheckDigit.java|  4 +-
 .../routines/checkdigit/ISBNCheckDigit.java|  4 +-
 .../routines/checkdigit/ModulusCheckDigit.java |  4 +-
 .../routines/checkdigit/ModulusTenCheckDigit.java  | 10 ++--
 .../routines/checkdigit/VerhoeffCheckDigit.java|  4 +-
 .../commons/validator/routines/package-info.java   |  4 +-
 .../validator/GenericTypeValidatorImpl.java| 56 +++---
 .../commons/validator/GenericValidatorImpl.java| 32 ++---
 40 files changed, 182 insertions(+), 182 deletions(-)

diff --git a/src/main/java/org/apache/commons/validator/Arg.java 
b/src/main/java/org/apache/commons/validator/Arg.java
index 55c416c9..7bed4c96 100644
--- a/src/main/java/org/apache/commons/validator/Arg.java
+++ b/src/main/java/org/apache/commons/validator/Arg.java
@@ -118,7 +118,7 @@ public class Arg implements Cloneable, Serializable {
 
 /**
  * Tests whether or not the key is a resource key or literal value.
- * @return true if key is a resource key.
+ * @return {@code true} if key is a resource key.
  */
 public boolean isResource() {
 return this.resource;
diff --git a/src/main/java/org/apache/commons/validator/DateValidator.java 
b/src/main/java/org/apache/commons/validator/DateValidator.java
index 374b4c08..37517fa2 100644
--- a/src/main/java/org/apache/commons/validator/DateValidator.java
+++ b/src/main/java/org/apache/commons/validator/DateValidator.java
@@ -59,7 +59,7 @@ public class DateValidator {
  * java.text.SimpleDateFormat.  If strict is true, then the
  * length will be checked so '2/12/1999' will not pass validation with
  * the format 'MM/dd/' because the month isn't two digits.
- * The setLenient method is set to false for all.
+ * 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 SimpleDateFormat.
@@ -94,7 +94,7 @@ public class DateValidator {
 /**
  * Checks if the field is a valid date.  The Locale is
  * used with java.text.DateFormat.  The setLenient method
- * is set to false for all.
+ * 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
diff --git a/src/main/java/org/apache/commons/validator/Field.java 

[commons-validator] branch master updated: Javadoc: Remove extra "whitespace"

2023-03-25 Thread ggregory
This is an automated email from the ASF dual-hosted git repository.

ggregory 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 0692ff50 Javadoc: Remove extra "whitespace"
0692ff50 is described below

commit 0692ff50d342e38ef35243f0cd39836e46898096
Author: Gary Gregory 
AuthorDate: Sat Mar 25 09:58:39 2023 -0400

Javadoc: Remove extra "whitespace"
---
 .../java/org/apache/commons/validator/routines/EmailValidatorTest.java   | 1 -
 1 file changed, 1 deletion(-)

diff --git 
a/src/test/java/org/apache/commons/validator/routines/EmailValidatorTest.java 
b/src/test/java/org/apache/commons/validator/routines/EmailValidatorTest.java
index 04b9c89c..6c8071e1 100644
--- 
a/src/test/java/org/apache/commons/validator/routines/EmailValidatorTest.java
+++ 
b/src/test/java/org/apache/commons/validator/routines/EmailValidatorTest.java
@@ -34,7 +34,6 @@ import org.junit.Test;
 
 /**
  * Performs Validation Test for e-mail validations.
- *
  */
 public class EmailValidatorTest {
 



[commons-validator] branch master updated: Javadoc/Comments: Remove extra "whitespace"

2023-03-25 Thread ggregory
This is an automated email from the ASF dual-hosted git repository.

ggregory 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 1f418edc Javadoc/Comments: Remove extra "whitespace"
1f418edc is described below

commit 1f418edc7d503e4416df840e67396867cc9da732
Author: Gary Gregory 
AuthorDate: Sat Mar 25 09:47:41 2023 -0400

Javadoc/Comments: Remove extra "whitespace"
---
 src/main/java/org/apache/commons/validator/Arg.java  | 1 -
 src/main/java/org/apache/commons/validator/Form.java | 1 -
 src/main/java/org/apache/commons/validator/FormSet.java  | 1 -
 src/main/java/org/apache/commons/validator/GenericTypeValidator.java | 1 -
 src/main/java/org/apache/commons/validator/GenericValidator.java | 1 -
 src/main/java/org/apache/commons/validator/Msg.java  | 1 -
 src/main/java/org/apache/commons/validator/Validator.java| 1 -
 src/main/java/org/apache/commons/validator/ValidatorAction.java  | 1 -
 src/main/java/org/apache/commons/validator/ValidatorException.java   | 1 -
 src/main/java/org/apache/commons/validator/ValidatorResources.java   | 1 -
 src/main/java/org/apache/commons/validator/ValidatorResult.java  | 1 -
 src/main/java/org/apache/commons/validator/ValidatorResults.java | 1 -
 src/main/java/org/apache/commons/validator/Var.java  | 1 -
 src/main/java/org/apache/commons/validator/util/Flags.java   | 1 -
 src/main/java/org/apache/commons/validator/util/ValidatorUtils.java  | 1 -
 src/test/java/org/apache/commons/validator/AbstractCommonTest.java   | 1 -
 src/test/java/org/apache/commons/validator/AbstractNumberTest.java   | 1 -
 src/test/java/org/apache/commons/validator/ByteTest.java | 1 -
 .../java/org/apache/commons/validator/CustomValidatorResourcesTest.java  | 1 -
 src/test/java/org/apache/commons/validator/DateTest.java | 1 -
 src/test/java/org/apache/commons/validator/DoubleTest.java   | 1 -
 src/test/java/org/apache/commons/validator/EntityImportTest.java | 1 -
 src/test/java/org/apache/commons/validator/ExceptionTest.java| 1 -
 src/test/java/org/apache/commons/validator/ExtensionTest.java| 1 -
 src/test/java/org/apache/commons/validator/FieldTest.java| 1 -
 src/test/java/org/apache/commons/validator/FloatTest.java| 1 -
 src/test/java/org/apache/commons/validator/GenericTypeValidatorImpl.java | 1 -
 src/test/java/org/apache/commons/validator/GenericTypeValidatorTest.java | 1 -
 src/test/java/org/apache/commons/validator/GenericValidatorImpl.java | 1 -
 src/test/java/org/apache/commons/validator/GenericValidatorTest.java | 1 -
 src/test/java/org/apache/commons/validator/IntegerTest.java  | 1 -
 src/test/java/org/apache/commons/validator/LocaleTest.java   | 1 -
 src/test/java/org/apache/commons/validator/LongTest.java | 1 -
 src/test/java/org/apache/commons/validator/MultipleConfigFilesTest.java  | 1 -
 src/test/java/org/apache/commons/validator/MultipleTest.java | 1 -
 src/test/java/org/apache/commons/validator/NameBean.java | 1 -
 src/test/java/org/apache/commons/validator/ParameterTest.java| 1 -
 src/test/java/org/apache/commons/validator/ParameterValidatorImpl.java   | 1 -
 src/test/java/org/apache/commons/validator/RequiredIfTest.java   | 1 -
 src/test/java/org/apache/commons/validator/RequiredNameTest.java | 1 -
 src/test/java/org/apache/commons/validator/RetrieveFormTest.java | 1 -
 src/test/java/org/apache/commons/validator/ShortTest.java| 1 -
 src/test/java/org/apache/commons/validator/TypeBean.java | 1 -
 src/test/java/org/apache/commons/validator/ValidatorResourcesTest.java   | 1 -
 src/test/java/org/apache/commons/validator/ValidatorResultsTest.java | 1 -
 src/test/java/org/apache/commons/validator/ValidatorTest.java| 1 -
 src/test/java/org/apache/commons/validator/ValueBean.java| 1 -
 src/test/java/org/apache/commons/validator/VarTest.java  | 1 -
 .../org/apache/commons/validator/custom/CustomValidatorResources.java| 1 -
 .../apache/commons/validator/routines/AbstractCalendarValidatorTest.java | 1 -
 .../apache/commons/validator/routines/AbstractNumberValidatorTest.java   | 1 -
 .../org/apache/commons/validator/routines/BigDecimalValidatorTest.java   | 1 -
 .../org/apache/commons/validator/routines/BigIntegerValidatorTest.java   | 1 -
 .../java/org/apache/commons/validator/routines/ByteValidatorTest.java| 1 -
 .../org/apache/commons/validator/routines/CalendarValidatorTest.java | 1 -
 .../org/apache/commons/validator/routines/CreditCardValidatorTest.java   | 1 -
 

[commons-validator] branch master updated: Javadoc @see tags do not need to use a FQCN for classes in java.lang

2022-08-29 Thread ggregory
This is an automated email from the ASF dual-hosted git repository.

ggregory 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 e55f37f5 Javadoc @see tags do not need to use a FQCN for classes in 
java.lang
e55f37f5 is described below

commit e55f37f550b6e1d705c73af885a6998e890ba1bc
Author: Gary Gregory 
AuthorDate: Mon Aug 29 07:22:02 2022 -0400

Javadoc @see tags do not need to use a FQCN for classes in java.lang
---
 src/main/java/org/apache/commons/validator/util/Flags.java | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

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 30550f47..67c50a93 100644
--- a/src/main/java/org/apache/commons/validator/util/Flags.java
+++ b/src/main/java/org/apache/commons/validator/util/Flags.java
@@ -141,7 +141,7 @@ public class Flags implements Serializable, Cloneable {
  * Clone this Flags object.
  *
  * @return a copy of this object.
- * @see java.lang.Object#clone()
+ * @see Object#clone()
  */
 @Override
 public Object clone() {
@@ -155,7 +155,7 @@ public class Flags implements Serializable, Cloneable {
 /**
  * Tests if two Flags objects are in the same state.
  * @param obj object being tested
- * @see java.lang.Object#equals(java.lang.Object)
+ * @see Object#equals(Object)
  *
  * @return whether the objects are equal.
  */
@@ -176,7 +176,7 @@ public class Flags implements Serializable, Cloneable {
 
 /**
  * The hash code is based on the current state of the flags.
- * @see java.lang.Object#hashCode()
+ * @see Object#hashCode()
  *
  * @return the hash code for this object.
  */



[commons-validator] branch master updated: Javadoc fix

2020-06-24 Thread sebb
This is an automated email from the ASF dual-hosted git repository.

sebb 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 1720064  Javadoc fix
1720064 is described below

commit 1720064cf8885c37bec2c275b61e9e3b57101993
Author: Sebb 
AuthorDate: Wed Jun 24 17:32:18 2020 +0100

Javadoc fix
---
 src/main/java/org/apache/commons/validator/routines/ISBNValidator.java | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git 
a/src/main/java/org/apache/commons/validator/routines/ISBNValidator.java 
b/src/main/java/org/apache/commons/validator/routines/ISBNValidator.java
index 8c759c0..0f8036e 100644
--- a/src/main/java/org/apache/commons/validator/routines/ISBNValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/ISBNValidator.java
@@ -59,7 +59,7 @@ import 
org.apache.commons.validator.routines.checkdigit.CheckDigitException;
  * 979-10, 979-11, 979-12 are assigned to the ISBN agency
  * 
  * All other 979 prefixed EAN-13 numbers have not yet been assigned to an 
agency. The
- * validator validates all 13 digit codes with 978 or 979 prefixes.
+ * validator validates all 13 digit codes with 978 or 979 prefixes.
  *
  * @version $Revision$
  * @since Validator 1.4



[commons-validator] branch master updated: Javadoc

2020-06-24 Thread sebb
This is an automated email from the ASF dual-hosted git repository.

sebb 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 8bb4a4c  Javadoc
8bb4a4c is described below

commit 8bb4a4c7b16266462cfe0aeb5dcdb85012917482
Author: Sebb 
AuthorDate: Wed Jun 24 17:18:17 2020 +0100

Javadoc
---
 .../java/org/apache/commons/validator/routines/DomainValidator.java   | 4 
 1 file changed, 4 insertions(+)

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 4034c18..59cdae7 100644
--- a/src/main/java/org/apache/commons/validator/routines/DomainValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/DomainValidator.java
@@ -201,6 +201,10 @@ public class DomainValidator implements Serializable {
  * Returns true if the specified String matches any
  * IANA-defined top-level domain. Leading dots are ignored if present.
  * The search is case-insensitive.
+ * 
+ * If allowLocal is true, the TLD is checked using {@link 
#isValidLocalTld(String)}.
+ * The TLD is then checked against {@link 
#isValidInfrastructureTld(String)},
+ * {@link #isValidGenericTld(String)} and {@link 
#isValidCountryCodeTld(String)}
  * @param tld the parameter to check for TLD status, not null
  * @return true if the parameter is a TLD
  */



[commons-validator] branch master updated: Javadoc fixes

2020-06-20 Thread sebb
This is an automated email from the ASF dual-hosted git repository.

sebb 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 cb38334  Javadoc fixes
cb38334 is described below

commit cb383341e01d084e29790b92d8f2982587e2c18d
Author: Sebb 
AuthorDate: Sat Jun 20 11:46:48 2020 +0100

Javadoc fixes
---
 .../java/org/apache/commons/validator/package.html | 38 -
 .../apache/commons/validator/routines/package.html | 96 --
 2 files changed, 71 insertions(+), 63 deletions(-)

diff --git a/src/main/java/org/apache/commons/validator/package.html 
b/src/main/java/org/apache/commons/validator/package.html
index 929491f..66ba625 100644
--- a/src/main/java/org/apache/commons/validator/package.html
+++ b/src/main/java/org/apache/commons/validator/package.html
@@ -20,9 +20,9 @@
 
 
 The Validator package provides validation for JavaBeans based on an xml file.
-
-
-
+
+
+
 http://commons.apache.org/validator/dependencies.html;>[Dependencies]
 [Introduction]
 [Overview]
@@ -30,7 +30,7 @@ The Validator package provides validation for JavaBeans based 
on an xml file.
 [Usage Example]
 
 
-
+
 Introduction
 
 A common issue when receiving data either electronically or from
@@ -55,7 +55,7 @@ speed development and maintenance of validation rules.
Call the validate method on 
org.apache.commons.validator.Validator.
 
 
-
+
 Overview
 
The Commons Validator is a basic validation framework that
@@ -78,7 +78,7 @@ speed development and maintenance of validation rules.
associated with a fields validation.
 
 
-
+
 Resources
 
After a Validator instance is created, instances of
@@ -87,7 +87,8 @@ speed development and maintenance of validation rules.
method.  Below is a list of reserved parameters (class names).
 
 
-
+
+   Reserved Parameters

   Class Name
   Validator Contstant
@@ -134,7 +135,7 @@ speed development and maintenance of validation rules.
 
 
 
-
+
 Usage Example
 
This is a basic example setting up a required validator for
@@ -144,17 +145,17 @@ speed development and maintenance of validation rules.
 
 
Create an xml file with your validator and validation rules.
-   Setup your required validator in your xml file.
-   
-   XML Example
-   Validator Example
+   Setup your required validator in your xml file.
+   
+   XML Example
+   Validator Example
Pluggable Validator Example
 
 
-
+
 XML Example
 
-   Definition of a 'required' pluggable validator.
+   Definition of a 'required' pluggable validator.
 
 form-validation
global
@@ -167,9 +168,9 @@ speed development and maintenance of validation rules.
/formset
 /form-validation
 
-
+
 
-   Add validation rules to require a first name and a last name.
+   Add validation rules to require a first name and a last name.
 
 form-validation
global
@@ -192,9 +193,8 @@ speed development and maintenance of validation rules.
 
 /form-validation
 
-
 
-
+
 Validator Example
 
 Excerpts from org.apache.commons.validator.RequiredNameTest
@@ -227,7 +227,7 @@ if (results.get("firstName") == null) {
 }
 
 
-
+
 Pluggable Validator Example
 
 Validation method defined in the 'required' pluggable validator
diff --git a/src/main/java/org/apache/commons/validator/routines/package.html 
b/src/main/java/org/apache/commons/validator/routines/package.html
index 2898555..bfdecda 100644
--- a/src/main/java/org/apache/commons/validator/routines/package.html
+++ b/src/main/java/org/apache/commons/validator/routines/package.html
@@ -58,7 +58,7 @@
 
 
 
-
+
 1. Overview
 
Commons Validator serves two purposes:
@@ -78,11 +78,11 @@
Commons Validator and can be used on their own.
 
 
-
+
 2. Date and Time Validators
 
-
-2.1 Overview
+
+2.1 Overview
 
The date and time validators either validate according to a specified 
format
or use a standard format for a specified Locale.
@@ -96,8 +96,8 @@
converting to a java.util.Calendar type.
 
 
-
-2.2 Validating a Date Value
+
+2.2 Validating a Date Value
 
You can either use one of the isValid() methods to just 
determine
if a date is valid, or use one of the validate() methods to
@@ -133,8 +133,8 @@
 validate(value, pattern, Locale)
 
 
-
-2.3 Formatting
+
+2.3 Formatting
 
Formatting and validating are two sides of the same coin. Typically
input values which are converted from Strings according to a
@@ -150,8 +150,8 @@
 format(date/calendar, pattern, Locale)
 
 
-
-2.4 Time Zones
+
+2.4 Time Zones
 
If the date being parsed relates to a different time zone than the
system default, you can specify the TimeZone to use when
@@ -174,8 +174,8 @@
 validate(value, pattern, Locale, 
TimeZone)
 
 
-
-2.5 Comparing Dates and Times
+
+2.5 Comparing Dates and Times
 
As well as validating that a value is a valid date or time, these validators
also provide date comparison functions. The