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 <garydgreg...@gmail.com>
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:
* <ul>
* <li>The class loader set by <code>setClassLoader()</code>, if any</li>
@@ -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 Iterator of the action names contained in this Result.
* @return The set of action names.
*/
public Iterator<String> getActions() {
@@ -184,7 +184,7 @@ public class ValidatorResult implements Serializable {
}
/**
- * Return the result of a validation.
+ * Gets the result of a validation.
* @param validatorName Name of the validator.
* @return The validation result.
*/
diff --git a/src/main/java/org/apache/commons/validator/ValidatorResults.java
b/src/main/java/org/apache/commons/validator/ValidatorResults.java
index 9c1063c3..1bddbbbe 100644
--- a/src/main/java/org/apache/commons/validator/ValidatorResults.java
+++ b/src/main/java/org/apache/commons/validator/ValidatorResults.java
@@ -80,7 +80,7 @@ public class ValidatorResults implements Serializable {
}
/**
- * Return the set of property names for which at least one message has
+ * Gets the set of property names for which at least one message has
* been recorded.
* @return An unmodifiable Set of the property names.
*/
@@ -128,7 +128,7 @@ public class ValidatorResults implements Serializable {
}
/**
- * Return {@code true} if there are no messages recorded
+ * Gets {@code true} if there are no messages recorded
* in this collection, or {@code false} otherwise.
*
* @return Whether these results are empty.
diff --git
a/src/main/java/org/apache/commons/validator/routines/BigDecimalValidator.java
b/src/main/java/org/apache/commons/validator/routines/BigDecimalValidator.java
index f521ab4e..9a1db632 100644
---
a/src/main/java/org/apache/commons/validator/routines/BigDecimalValidator.java
+++
b/src/main/java/org/apache/commons/validator/routines/BigDecimalValidator.java
@@ -72,7 +72,7 @@ public class BigDecimalValidator extends
AbstractNumberValidator {
private static final BigDecimalValidator VALIDATOR = new
BigDecimalValidator();
/**
- * Return a singleton instance of this validator.
+ * Gets the singleton instance of this validator.
* @return A singleton instance of the BigDecimalValidator.
*/
public static BigDecimalValidator getInstance() {
diff --git
a/src/main/java/org/apache/commons/validator/routines/BigIntegerValidator.java
b/src/main/java/org/apache/commons/validator/routines/BigIntegerValidator.java
index 45c5157a..7a2d3085 100644
---
a/src/main/java/org/apache/commons/validator/routines/BigIntegerValidator.java
+++
b/src/main/java/org/apache/commons/validator/routines/BigIntegerValidator.java
@@ -69,7 +69,7 @@ public class BigIntegerValidator extends
AbstractNumberValidator {
private static final BigIntegerValidator VALIDATOR = new
BigIntegerValidator();
/**
- * Return a singleton instance of this validator.
+ * Gets the singleton instance of this validator.
* @return A singleton instance of the BigIntegerValidator.
*/
public static BigIntegerValidator getInstance() {
diff --git
a/src/main/java/org/apache/commons/validator/routines/ByteValidator.java
b/src/main/java/org/apache/commons/validator/routines/ByteValidator.java
index 63869ae4..ad26fc49 100644
--- a/src/main/java/org/apache/commons/validator/routines/ByteValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/ByteValidator.java
@@ -68,7 +68,7 @@ public class ByteValidator extends AbstractNumberValidator {
private static final ByteValidator VALIDATOR = new ByteValidator();
/**
- * Return a singleton instance of this validator.
+ * Gets the singleton instance of this validator.
* @return A singleton instance of the ByteValidator.
*/
public static ByteValidator getInstance() {
diff --git
a/src/main/java/org/apache/commons/validator/routines/CalendarValidator.java
b/src/main/java/org/apache/commons/validator/routines/CalendarValidator.java
index 5f09d0bd..4428b7c5 100644
--- a/src/main/java/org/apache/commons/validator/routines/CalendarValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/CalendarValidator.java
@@ -111,7 +111,7 @@ public class CalendarValidator extends
AbstractCalendarValidator {
}
/**
- * Return a singleton instance of this validator.
+ * Gets the singleton instance of this validator.
* @return A singleton instance of the CalendarValidator.
*/
public static CalendarValidator getInstance() {
diff --git
a/src/main/java/org/apache/commons/validator/routines/CodeValidator.java
b/src/main/java/org/apache/commons/validator/routines/CodeValidator.java
index e02ad8f2..81dd877c 100644
--- a/src/main/java/org/apache/commons/validator/routines/CodeValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/CodeValidator.java
@@ -172,7 +172,7 @@ public final class CodeValidator implements Serializable {
}
/**
- * Return the check digit validation routine.
+ * Gets the check digit validation routine.
* <p>
* <b>N.B.</b> Optional, if not set no Check Digit
* validation will be performed on the code.
@@ -184,7 +184,7 @@ public final class CodeValidator implements Serializable {
}
/**
- * Return the maximum length of the code.
+ * Gets the maximum length of the code.
* <p>
* <b>N.B.</b> Optional, if less than zero the
* maximum length will not be checked.
@@ -197,7 +197,7 @@ public final class CodeValidator implements Serializable {
}
/**
- * Return the minimum length of the code.
+ * Gets the minimum length of the code.
* <p>
* <b>N.B.</b> Optional, if less than zero the
* minimum length will not be checked.
@@ -210,7 +210,7 @@ public final class CodeValidator implements Serializable {
}
/**
- * Return the <i>regular expression</i> validator.
+ * Gets the <i>regular expression</i> validator.
* <p>
* <b>N.B.</b> Optional, if not set no regular
* expression validation will be performed on the code.
diff --git
a/src/main/java/org/apache/commons/validator/routines/CurrencyValidator.java
b/src/main/java/org/apache/commons/validator/routines/CurrencyValidator.java
index f88ce052..5afba19f 100644
--- a/src/main/java/org/apache/commons/validator/routines/CurrencyValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/CurrencyValidator.java
@@ -51,7 +51,7 @@ public class CurrencyValidator extends BigDecimalValidator {
private static final char CURRENCY_SYMBOL = '\u00A4';
/**
- * Return a singleton instance of this validator.
+ * Gets the singleton instance of this validator.
* @return A singleton instance of the CurrencyValidator.
*/
public static BigDecimalValidator getInstance() {
diff --git
a/src/main/java/org/apache/commons/validator/routines/DateValidator.java
b/src/main/java/org/apache/commons/validator/routines/DateValidator.java
index 90c4328e..ceeef158 100644
--- a/src/main/java/org/apache/commons/validator/routines/DateValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/DateValidator.java
@@ -88,7 +88,7 @@ public class DateValidator extends AbstractCalendarValidator {
private static final DateValidator VALIDATOR = new DateValidator();
/**
- * Return a singleton instance of this validator.
+ * Gets the singleton instance of this validator.
* @return A singleton instance of the DateValidator.
*/
public static DateValidator getInstance() {
diff --git
a/src/main/java/org/apache/commons/validator/routines/DoubleValidator.java
b/src/main/java/org/apache/commons/validator/routines/DoubleValidator.java
index 8702da4a..f7ef52e6 100644
--- a/src/main/java/org/apache/commons/validator/routines/DoubleValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/DoubleValidator.java
@@ -68,7 +68,7 @@ public class DoubleValidator extends AbstractNumberValidator {
private static final DoubleValidator VALIDATOR = new DoubleValidator();
/**
- * Return a singleton instance of this validator.
+ * Gets the singleton instance of this validator.
* @return A singleton instance of the DoubleValidator.
*/
public static DoubleValidator getInstance() {
diff --git
a/src/main/java/org/apache/commons/validator/routines/FloatValidator.java
b/src/main/java/org/apache/commons/validator/routines/FloatValidator.java
index ed1c67c9..ede83912 100644
--- a/src/main/java/org/apache/commons/validator/routines/FloatValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/FloatValidator.java
@@ -68,7 +68,7 @@ public class FloatValidator extends AbstractNumberValidator {
private static final FloatValidator VALIDATOR = new FloatValidator();
/**
- * Return a singleton instance of this validator.
+ * Gets the singleton instance of this validator.
* @return A singleton instance of the FloatValidator.
*/
public static FloatValidator getInstance() {
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 87efb2f0..42282efb 100644
--- a/src/main/java/org/apache/commons/validator/routines/IBANValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/IBANValidator.java
@@ -239,7 +239,7 @@ public class IBANValidator {
public static final IBANValidator DEFAULT_IBAN_VALIDATOR = new
IBANValidator();
/**
- * Return a singleton instance of the IBAN validator using the default
formats
+ * Gets the singleton instance of the IBAN validator using the default
formats
*
* @return A singleton instance of the IBAN validator
*/
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 e0229ee9..6784159e 100644
--- a/src/main/java/org/apache/commons/validator/routines/ISBNValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/ISBNValidator.java
@@ -96,7 +96,7 @@ public class ISBNValidator implements Serializable {
private static final ISBNValidator ISBN_VALIDATOR_NO_CONVERT = new
ISBNValidator(false);
/**
- * Return a singleton instance of the ISBN validator which
+ * Gets the singleton instance of the ISBN validator which
* converts ISBN-10 codes to ISBN-13.
*
* @return A singleton instance of the ISBN validator.
@@ -106,7 +106,7 @@ public class ISBNValidator implements Serializable {
}
/**
- * Return a singleton instance of the ISBN validator specifying
+ * Gets the singleton instance of the ISBN validator specifying
* whether ISBN-10 codes should be converted to ISBN-13.
*
* @param convert {@code true} if valid ISBN-10 codes
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 6e379f6e..5a812f3d 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,7 @@ public class ISINValidator implements Serializable {
}
/**
- * Return a 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.
*/
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 53c49ec7..78f11e20 100644
--- a/src/main/java/org/apache/commons/validator/routines/ISSNValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/ISSNValidator.java
@@ -82,7 +82,7 @@ public class ISSNValidator implements Serializable {
private static final ISSNValidator ISSN_VALIDATOR = new ISSNValidator();
/**
- * Return a singleton instance of the ISSN validator
+ * Gets the singleton instance of the ISSN validator
*
* @return A singleton instance of the ISSN validator.
*/
diff --git
a/src/main/java/org/apache/commons/validator/routines/IntegerValidator.java
b/src/main/java/org/apache/commons/validator/routines/IntegerValidator.java
index 11b3b113..0882bac1 100644
--- a/src/main/java/org/apache/commons/validator/routines/IntegerValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/IntegerValidator.java
@@ -68,7 +68,7 @@ public class IntegerValidator extends AbstractNumberValidator
{
private static final IntegerValidator VALIDATOR = new IntegerValidator();
/**
- * Return a singleton instance of this validator.
+ * Gets the singleton instance of this validator.
* @return A singleton instance of the IntegerValidator.
*/
public static IntegerValidator getInstance() {
diff --git
a/src/main/java/org/apache/commons/validator/routines/LongValidator.java
b/src/main/java/org/apache/commons/validator/routines/LongValidator.java
index 09c9d523..079a151e 100644
--- a/src/main/java/org/apache/commons/validator/routines/LongValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/LongValidator.java
@@ -67,7 +67,7 @@ public class LongValidator extends AbstractNumberValidator {
private static final LongValidator VALIDATOR = new LongValidator();
/**
- * Return a singleton instance of this validator.
+ * Gets the singleton instance of this validator.
* @return A singleton instance of the LongValidator.
*/
public static LongValidator getInstance() {
diff --git
a/src/main/java/org/apache/commons/validator/routines/PercentValidator.java
b/src/main/java/org/apache/commons/validator/routines/PercentValidator.java
index 343cad1a..635dbe95 100644
--- a/src/main/java/org/apache/commons/validator/routines/PercentValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/PercentValidator.java
@@ -56,7 +56,7 @@ public class PercentValidator extends BigDecimalValidator {
private static final BigDecimal POINT_ZERO_ONE = new BigDecimal("0.01");
/**
- * Return a singleton instance of this validator.
+ * Gets the singleton instance of this validator.
* @return A singleton instance of the PercentValidator.
*/
public static BigDecimalValidator getInstance() {
diff --git
a/src/main/java/org/apache/commons/validator/routines/ShortValidator.java
b/src/main/java/org/apache/commons/validator/routines/ShortValidator.java
index 34626185..f23d6762 100644
--- a/src/main/java/org/apache/commons/validator/routines/ShortValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/ShortValidator.java
@@ -68,7 +68,7 @@ public class ShortValidator extends AbstractNumberValidator {
private static final ShortValidator VALIDATOR = new ShortValidator();
/**
- * Return a singleton instance of this validator.
+ * Gets the singleton instance of this validator.
* @return A singleton instance of the ShortValidator.
*/
public static ShortValidator getInstance() {
diff --git
a/src/main/java/org/apache/commons/validator/routines/TimeValidator.java
b/src/main/java/org/apache/commons/validator/routines/TimeValidator.java
index 90148b3f..eee7ad42 100644
--- a/src/main/java/org/apache/commons/validator/routines/TimeValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/TimeValidator.java
@@ -88,7 +88,7 @@ public class TimeValidator extends AbstractCalendarValidator {
private static final TimeValidator VALIDATOR = new TimeValidator();
/**
- * Return a singleton instance of this validator.
+ * Gets the singleton instance of this validator.
* @return A singleton instance of the TimeValidator.
*/
public static TimeValidator getInstance() {
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 bf266dd0..ba994ca6 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
@@ -116,7 +116,7 @@ public abstract class ModulusCheckDigit implements
CheckDigit, Serializable {
}
/**
- * Return the modulus value this check digit routine is based on.
+ * Gets the modulus value this check digit routine is based on.
*
* @return The modulus value this check digit routine is based on
*/
