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 c61dce5f Javadoc: Empty Javadoc line before the 1st tag.
c61dce5f is described below
commit c61dce5f4a2b3b1f4e394d29ad303a2c6af95177
Author: Gary Gregory <[email protected]>
AuthorDate: Wed Dec 31 18:07:10 2025 -0500
Javadoc: Empty Javadoc line before the 1st tag.
---
.../java/org/apache/commons/validator/Arg.java | 3 ++
.../commons/validator/CreditCardValidator.java | 7 ++++
.../apache/commons/validator/DateValidator.java | 1 +
.../apache/commons/validator/EmailValidator.java | 5 +++
.../java/org/apache/commons/validator/Field.java | 42 ++++++++++++++++++++++
.../apache/commons/validator/GenericValidator.java | 1 +
.../java/org/apache/commons/validator/Msg.java | 12 +++++++
.../org/apache/commons/validator/UrlValidator.java | 9 +++++
.../org/apache/commons/validator/Validator.java | 6 ++++
.../commons/validator/ValidatorResources.java | 15 ++++++++
.../apache/commons/validator/ValidatorResult.java | 14 ++++++++
.../apache/commons/validator/ValidatorResults.java | 1 +
.../java/org/apache/commons/validator/Var.java | 13 +++++++
.../validator/routines/BigDecimalValidator.java | 1 +
.../validator/routines/BigIntegerValidator.java | 1 +
.../commons/validator/routines/ByteValidator.java | 1 +
.../validator/routines/CalendarValidator.java | 1 +
.../validator/routines/CreditCardValidator.java | 13 +++++++
.../validator/routines/CurrencyValidator.java | 1 +
.../commons/validator/routines/DateValidator.java | 1 +
.../validator/routines/DomainValidator.java | 4 +++
.../validator/routines/DoubleValidator.java | 1 +
.../commons/validator/routines/FloatValidator.java | 1 +
.../commons/validator/routines/IBANValidator.java | 1 +
.../commons/validator/routines/ISSNValidator.java | 1 +
.../validator/routines/IntegerValidator.java | 1 +
.../commons/validator/routines/LongValidator.java | 1 +
.../validator/routines/PercentValidator.java | 1 +
.../commons/validator/routines/ShortValidator.java | 1 +
.../commons/validator/routines/TimeValidator.java | 1 +
.../commons/validator/routines/UrlValidator.java | 13 +++++++
.../routines/checkdigit/CASNumberCheckDigit.java | 1 +
.../routines/checkdigit/ECNumberCheckDigit.java | 1 +
.../routines/checkdigit/ISSNCheckDigit.java | 1 +
.../org/apache/commons/validator/util/Flags.java | 3 ++
35 files changed, 180 insertions(+)
diff --git a/src/main/java/org/apache/commons/validator/Arg.java
b/src/main/java/org/apache/commons/validator/Arg.java
index d9440477..9548787e 100644
--- a/src/main/java/org/apache/commons/validator/Arg.java
+++ b/src/main/java/org/apache/commons/validator/Arg.java
@@ -42,6 +42,7 @@ public class Arg implements Cloneable, Serializable {
/**
* The resource bundle name that this Arg's {@code key} should be
* resolved in (optional).
+ *
* @since 1.1
*/
protected String bundle;
@@ -59,6 +60,7 @@ public class Arg implements Cloneable, Serializable {
/**
* This argument's position in the message. Set position=0 to
* make a replacement in this string: "some msg {0}".
+ *
* @since 1.1
*/
protected int position = -1;
@@ -79,6 +81,7 @@ public class Arg implements Cloneable, Serializable {
/**
* Creates and returns a copy of this object.
+ *
* @return A copy of this object.
*/
@Override
diff --git
a/src/main/java/org/apache/commons/validator/CreditCardValidator.java
b/src/main/java/org/apache/commons/validator/CreditCardValidator.java
index 4ccf2de7..9ab6cd12 100644
--- a/src/main/java/org/apache/commons/validator/CreditCardValidator.java
+++ b/src/main/java/org/apache/commons/validator/CreditCardValidator.java
@@ -69,6 +69,7 @@ public class CreditCardValidator {
/**
* CreditCardType implementations define how validation is performed
* for one type/brand of credit card.
+ *
* @since 1.1.2
*/
public interface CreditCardType {
@@ -81,6 +82,7 @@ public class CreditCardValidator {
* calling this method. It is generally only required to valid the
* length and prefix of the number to determine if it's the correct
* type.
+ *
* @param card The card number, never null.
* @return true if the number matches.
*/
@@ -132,6 +134,7 @@ public class CreditCardValidator {
* v.isValid(aCardNumber);
* }
* </pre>
+ *
* @since 1.1.2
*/
public static final int NONE = 0;
@@ -170,6 +173,7 @@ public class CreditCardValidator {
/**
* Creates a new CreditCardValidator with the specified options.
+ *
* @param options Pass in
* CreditCardValidator.VISA + CreditCardValidator.AMEX to specify that
* those are the only valid card types.
@@ -196,6 +200,7 @@ public class CreditCardValidator {
/**
* Adds an allowed CreditCardType that participates in the card
* validation algorithm.
+ *
* @param type The type that is now allowed to pass validation.
* @since 1.1.2
*/
@@ -205,6 +210,7 @@ public class CreditCardValidator {
/**
* Checks if the field is a valid credit card number.
+ *
* @param card The card number to validate.
* @return Whether the card number is valid.
*/
@@ -223,6 +229,7 @@ public class CreditCardValidator {
/**
* Checks for a valid credit card number.
+ *
* @param cardNumber Credit Card Number.
* @return Whether the card number passes the luhnCheck.
*/
diff --git a/src/main/java/org/apache/commons/validator/DateValidator.java
b/src/main/java/org/apache/commons/validator/DateValidator.java
index 15349673..e9af92fa 100644
--- a/src/main/java/org/apache/commons/validator/DateValidator.java
+++ b/src/main/java/org/apache/commons/validator/DateValidator.java
@@ -42,6 +42,7 @@ public class DateValidator {
/**
* Returns 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/EmailValidator.java
b/src/main/java/org/apache/commons/validator/EmailValidator.java
index b581b2c6..d949d49f 100644
--- a/src/main/java/org/apache/commons/validator/EmailValidator.java
+++ b/src/main/java/org/apache/commons/validator/EmailValidator.java
@@ -65,6 +65,7 @@ public class EmailValidator {
/**
* Returns the Singleton instance of this validator.
+ *
* @return singleton instance of this validator.
*/
public static EmailValidator getInstance() {
@@ -90,6 +91,7 @@ public class EmailValidator {
/**
* Returns true if the domain component of an email address is valid.
+ *
* @param domain being validated.
* @return true if the email address's domain is valid.
*/
@@ -119,6 +121,7 @@ public class EmailValidator {
/**
* Validates an IP address. Returns true if valid.
+ *
* @param ipAddress IP address
* @return true if the ip address is valid.
*/
@@ -148,6 +151,7 @@ public class EmailValidator {
/**
* Validates a symbolic domain name. Returns true if it's valid.
+ *
* @param domain symbolic domain name
* @return true if the symbolic domain name is valid.
*/
@@ -187,6 +191,7 @@ public class EmailValidator {
/**
* Returns true if the user component of an email address is valid.
+ *
* @param user being validated
* @return true if the username 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 6e28f33f..4ac8c0a4 100644
--- a/src/main/java/org/apache/commons/validator/Field.java
+++ b/src/main/java/org/apache/commons/validator/Field.java
@@ -108,6 +108,7 @@ public class Field implements Cloneable, Serializable {
/**
* The flag that indicates whether scripting should be generated
* by the client for client-side validation.
+ *
* @since 1.4
*/
protected volatile boolean clientValidation = true;
@@ -141,6 +142,7 @@ public class Field implements Cloneable, Serializable {
* Holds Maps of arguments. args[0] returns the Map for the first
* replacement argument. Start with a 0 length array so that it will
* only grow to the size of the highest argument position.
+ *
* @since 1.1
*/
@SuppressWarnings("unchecked") // cannot instantiate generic array, so
have to assume this is OK
@@ -180,6 +182,7 @@ public class Field implements Cloneable, Serializable {
/**
* Add a {@code Msg} to the {@code Field}.
+ *
* @param msg A validation message.
*/
public void addMsg(final Msg msg) {
@@ -189,6 +192,7 @@ public class Field implements Cloneable, Serializable {
/**
* Add a {@code Var}, based on the values passed in, to the
* {@code Field}.
+ *
* @param name Name of the validation.
* @param value The Argument's value.
* @param jsType The JavaScript type.
@@ -199,6 +203,7 @@ public class Field implements Cloneable, Serializable {
/**
* Add a {@code Var} to the {@code Field}.
+ *
* @param v The Validator Argument.
*/
public void addVar(final Var v) {
@@ -207,6 +212,7 @@ public class Field implements Cloneable, Serializable {
/**
* Creates and returns a copy of this object.
+ *
* @return A copy of the Field.
*/
@Override
@@ -281,6 +287,7 @@ public class Field implements Cloneable, Serializable {
/**
* Ensures that the args array can hold the given arg. Resizes the array
as
* necessary.
+ *
* @param arg Determine if the args array is long enough to store this
arg's
* position.
*/
@@ -307,6 +314,7 @@ public class Field implements Cloneable, Serializable {
/**
* Gets the default {@code Arg} object at the given position.
+ *
* @param position Validation message argument's position.
* @return The default Arg or null if not found.
* @since 1.1
@@ -319,6 +327,7 @@ public class Field implements Cloneable, Serializable {
* Gets the {@code Arg} object at the given position. If the key
* 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.
* @param position The Arg number to find.
@@ -343,6 +352,7 @@ public class Field implements Cloneable, Serializable {
/**
* Gets the Args for the given validator name.
+ *
* @param key The validator's args to retrieve.
* @return An Arg[] sorted by the Args' positions (for example, the Arg at
index 0
* has a position of 0).
@@ -361,6 +371,7 @@ public class Field implements Cloneable, Serializable {
/**
* Gets an unmodifiable {@code List} of the dependencies in the same
* order they were defined in parameter passed to the setDepends() method.
+ *
* @return A list of the Field's dependencies.
*/
public List<String> getDependencyList() {
@@ -369,6 +380,7 @@ public class Field implements Cloneable, Serializable {
/**
* Gets the validation rules for this field as a comma separated list.
+ *
* @return A comma separated list of validator names.
*/
public String getDepends() {
@@ -377,6 +389,7 @@ public class Field implements Cloneable, Serializable {
/**
* Gets the position of the {@code Field} in the validation list.
+ *
* @return The field position.
*/
public int getFieldOrder() {
@@ -389,6 +402,7 @@ public class Field implements Cloneable, Serializable {
* {@link Collection} used to retrieve the
* list and then loop through the list performing the specified
* validations.
+ *
* @return The field's indexed List property name.
*/
public String getIndexedListProperty() {
@@ -399,6 +413,7 @@ public class Field implements Cloneable, Serializable {
* Gets the indexed property name of the field. This
* is the method name that can take an {@code int} as
* a parameter for indexed property value retrieval.
+ *
* @return The field's indexed property name.
*/
public String getIndexedProperty() {
@@ -466,6 +481,7 @@ public class Field implements Cloneable, Serializable {
/**
* Gets a unique key based on the property and indexedProperty fields.
+ *
* @return a unique key for the field.
*/
public String getKey() {
@@ -478,6 +494,7 @@ public class Field implements Cloneable, Serializable {
/**
* Retrieve a message object.
+ *
* @param key Validation key.
* @return A validation message for a specified validator.
* @since 1.1.4
@@ -489,6 +506,7 @@ public class Field implements Cloneable, Serializable {
/**
* The {@code Field}'s messages are returned as an
* unmodifiable {@link Map}.
+ *
* @return Map of validation messages for the field.
* @since 1.1.4
*/
@@ -498,6 +516,7 @@ public class Field implements Cloneable, Serializable {
/**
* Retrieve a message value.
+ *
* @param key Validation key.
* @return A validation message for a specified validator.
*/
@@ -508,6 +527,7 @@ public class Field implements Cloneable, Serializable {
/**
* Returns a Map of String Msg names to Msg objects.
+ *
* @return A Map of the Field's messages.
* @since 1.2.0
*/
@@ -519,6 +539,7 @@ public class Field implements Cloneable, Serializable {
/**
* Gets the page value that the Field is associated with for
* validation.
+ *
* @return The page number.
*/
public int getPage() {
@@ -527,6 +548,7 @@ public class Field implements Cloneable, Serializable {
/**
* Gets the property name of the field.
+ *
* @return The field's property name.
*/
public String getProperty() {
@@ -535,6 +557,7 @@ public class Field implements Cloneable, Serializable {
/**
* Retrieve a variable.
+ *
* @param mainKey The Variable's key
* @return the Variable
*/
@@ -544,6 +567,7 @@ public class Field implements Cloneable, Serializable {
/**
* Returns a Map of String Var names to Var objects.
+ *
* @return A Map of the Field's variables.
* @since 1.2.0
*/
@@ -555,6 +579,7 @@ public class Field implements Cloneable, Serializable {
/**
* The {@code Field}'s variables are returned as an
* unmodifiable {@link Map}.
+ *
* @return the Map of Variable's for a Field.
*/
public Map<String, Var> getVars() {
@@ -563,6 +588,7 @@ public class Field implements Cloneable, Serializable {
/**
* Retrieve a variable's value.
+ *
* @param mainKey The Variable's key
* @return the Variable's value
*/
@@ -580,6 +606,7 @@ public class Field implements Cloneable, Serializable {
/**
* Called when a validator name is used in a depends clause but there is
* no know ValidatorAction configured for that name.
+ *
* @param name The name of the validator in the depends list.
* @throws ValidatorException
*/
@@ -591,6 +618,7 @@ public class Field implements Cloneable, Serializable {
/**
* Determines whether client-side scripting should be generated
* for this field. The default is {@code true}
+ *
* @return {@code true} for scripting; otherwise false
* @see #setClientValidation(boolean)
* @since 1.4
@@ -601,6 +629,7 @@ public class Field implements Cloneable, Serializable {
/**
* Checks if the validator is listed as a dependency.
+ *
* @param validatorName Name of the validator to check.
* @return Whether the field is dependant on a validator.
*/
@@ -612,6 +641,7 @@ public class Field implements Cloneable, Serializable {
* If there is a value specified for the indexedProperty field then
* {@code true} will be returned. Otherwise, it will be
* {@code false}.
+ *
* @return Whether the Field is indexed.
*/
public boolean isIndexed() {
@@ -712,6 +742,7 @@ public class Field implements Cloneable, Serializable {
/**
* Calls all of the validators that this validator depends on.
* TODO ValidatorAction should know how to run its own dependencies.
+ *
* @param va Run dependent validators for this action.
* @param results
* @param actions
@@ -750,6 +781,7 @@ public class Field implements Cloneable, Serializable {
/**
* Sets the flag that determines whether client-side scripting should
* be generated for this field.
+ *
* @param clientValidation the scripting flag
* @see #isClientValidation()
* @since 1.4
@@ -760,6 +792,7 @@ public class Field implements Cloneable, Serializable {
/**
* Sets the validation rules for this field as a comma separated list.
+ *
* @param depends A comma separated list of validator names.
*/
public void setDepends(final String depends) {
@@ -779,6 +812,7 @@ public class Field implements Cloneable, Serializable {
/**
* Sets the position of the {@code Field} in the validation list.
+ *
* @param fieldOrder The field position.
*/
public void setFieldOrder(final int fieldOrder) {
@@ -787,6 +821,7 @@ public class Field implements Cloneable, Serializable {
/**
* Sets the indexed property name of the field.
+ *
* @param indexedListProperty The field's indexed List property name.
*/
public void setIndexedListProperty(final String indexedListProperty) {
@@ -794,6 +829,7 @@ public class Field implements Cloneable, Serializable {
}
/**
* Sets the indexed property name of the field.
+ *
* @param indexedProperty The field's indexed property name.
*/
public void setIndexedProperty(final String indexedProperty) {
@@ -803,6 +839,7 @@ public class Field implements Cloneable, Serializable {
/**
* Sets a unique key for the field. This can be used to change
* the key temporarily to have a unique key for an indexed field.
+ *
* @param key a unique key for the field
*/
public void setKey(final String key) {
@@ -812,6 +849,7 @@ public class Field implements Cloneable, Serializable {
/**
* Sets the page value that the Field is associated with for
* validation.
+ *
* @param page The page number.
*/
public void setPage(final int page) {
@@ -820,6 +858,7 @@ public class Field implements Cloneable, Serializable {
/**
* Sets the property name of the field.
+ *
* @param property The field's property name.
*/
public void setProperty(final String property) {
@@ -828,6 +867,7 @@ public class Field implements Cloneable, Serializable {
/**
* Returns a string representation of the object.
+ *
* @return A string representation of the object.
*/
@Override
@@ -860,6 +900,7 @@ public class Field implements Cloneable, Serializable {
* Run the configured validations on this field. Run all validations
* in the depends clause over each item in turn, returning when the first
* one fails.
+ *
* @param params A Map of parameter class names to parameter values to pass
* into validation methods.
* @param actions A Map of validator names to ValidatorAction objects.
@@ -907,6 +948,7 @@ public class Field implements Cloneable, Serializable {
/**
* Executes the given ValidatorAction and all ValidatorActions that it
* depends on.
+ *
* @return true if the validation succeeded.
*/
private boolean validateForRule(
diff --git a/src/main/java/org/apache/commons/validator/GenericValidator.java
b/src/main/java/org/apache/commons/validator/GenericValidator.java
index 03bf08a1..d2ac1194 100644
--- a/src/main/java/org/apache/commons/validator/GenericValidator.java
+++ b/src/main/java/org/apache/commons/validator/GenericValidator.java
@@ -80,6 +80,7 @@ public class GenericValidator implements Serializable {
/**
* Checks if the field is a valid credit card number.
+ *
* @param value The value validation is being performed on.
* @return true if the value is valid Credit Card Number.
*/
diff --git a/src/main/java/org/apache/commons/validator/Msg.java
b/src/main/java/org/apache/commons/validator/Msg.java
index bfae21d1..8e63b629 100644
--- a/src/main/java/org/apache/commons/validator/Msg.java
+++ b/src/main/java/org/apache/commons/validator/Msg.java
@@ -32,6 +32,7 @@ public class Msg implements Cloneable, Serializable {
/**
* The resource bundle name that this Msg's {@code key} should be
* resolved in (optional).
+ *
* @since 1.1
*/
protected String bundle;
@@ -50,6 +51,7 @@ public class Msg implements Cloneable, Serializable {
* Whether or not the key is a message resource (optional). Defaults to
* true. If it is 'true', the value will try to be resolved as a message
* resource.
+ *
* @since 1.1.4
*/
protected boolean resource = true;
@@ -63,6 +65,7 @@ public class Msg implements Cloneable, Serializable {
/**
* Creates and returns a copy of this object.
+ *
* @return A copy of the Msg.
*/
@Override
@@ -77,6 +80,7 @@ public class Msg implements Cloneable, Serializable {
/**
* Returns the resource bundle name.
+ *
* @return The bundle name.
* @since 1.1
*/
@@ -86,6 +90,7 @@ public class Msg implements Cloneable, Serializable {
/**
* Gets the key/value.
+ *
* @return The message key/value.
*/
public String getKey() {
@@ -94,6 +99,7 @@ public class Msg implements Cloneable, Serializable {
/**
* Gets the name of the dependency.
+ *
* @return The dependency name.
*/
public String getName() {
@@ -102,6 +108,7 @@ public class Msg implements Cloneable, Serializable {
/**
* Tests whether or not the key is a resource key or literal value.
+ *
* @return {@code true} if key is a resource key.
* @since 1.1.4
*/
@@ -111,6 +118,7 @@ public class Msg implements Cloneable, Serializable {
/**
* Sets the resource bundle name.
+ *
* @param bundle The new bundle name.
* @since 1.1
*/
@@ -120,6 +128,7 @@ public class Msg implements Cloneable, Serializable {
/**
* Sets the key/value.
+ *
* @param key The message key/value.
*/
public void setKey(final String key) {
@@ -128,6 +137,7 @@ public class Msg implements Cloneable, Serializable {
/**
* Sets the name of the dependency.
+ *
* @param name The dependency name.
*/
public void setName(final String name) {
@@ -136,6 +146,7 @@ public class Msg implements Cloneable, Serializable {
/**
* Sets whether or not the key is a resource.
+ *
* @param resource If true indicates the key is a resource.
* @since 1.1.4
*/
@@ -145,6 +156,7 @@ public class Msg implements Cloneable, Serializable {
/**
* Returns a string representation of the object.
+ *
* @return Msg String representation.
*/
@Override
diff --git a/src/main/java/org/apache/commons/validator/UrlValidator.java
b/src/main/java/org/apache/commons/validator/UrlValidator.java
index 7f7b9f13..9a1907d1 100644
--- a/src/main/java/org/apache/commons/validator/UrlValidator.java
+++ b/src/main/java/org/apache/commons/validator/UrlValidator.java
@@ -195,6 +195,7 @@ public class UrlValidator implements Serializable {
/**
* Initialize a UrlValidator with the given validation options.
+ *
* @param options The options should be set using the public constants
declared in
* this class. To set multiple options you simply add them together. For
example,
* ALLOW_2_SLASHES + NO_FRAGMENTS enables both of those options.
@@ -205,6 +206,7 @@ public class UrlValidator implements Serializable {
/**
* Behavior of validation is modified by passing in several strings
options:
+ *
* @param schemes Pass in one or more URL schemes to consider valid,
passing in
* a null will default to "http,https,ftp" being valid.
* If a non-null schemes is specified then all valid schemes must
@@ -217,6 +219,7 @@ public class UrlValidator implements Serializable {
/**
* Behaviour of validation is modified by passing in options:
+ *
* @param schemes The set of valid schemes.
* @param options The options should be set using the public constants
declared in
* this class. To set multiple options you simply add them together. For
example,
@@ -238,6 +241,7 @@ public class UrlValidator implements Serializable {
/**
* Returns the number of times the token appears in the target.
+ *
* @param token Token value to be counted.
* @param target Target value to count tokens in.
* @return the number of tokens.
@@ -287,6 +291,7 @@ public class UrlValidator implements Serializable {
/**
* Returns true if the authority is properly formatted. An authority is
the combination
* of hostname and port. A {@code null} authority value is considered
invalid.
+ *
* @param authority Authority value to validate.
* @return true if authority (hostname and port) is valid.
*/
@@ -373,6 +378,7 @@ public class UrlValidator implements Serializable {
/**
* Returns true if the given fragment is null or fragments are allowed.
+ *
* @param fragment Fragment value to validate.
* @return true if fragment is valid.
*/
@@ -386,6 +392,7 @@ public class UrlValidator implements Serializable {
/**
* Returns true if the path is valid. A {@code null} value is considered
invalid.
+ *
* @param path Path value to validate.
* @return true if path is valid.
*/
@@ -410,6 +417,7 @@ public class UrlValidator implements Serializable {
/**
* Returns true if the query is null, or it's a properly formatted query
string.
+ *
* @param query Query value to validate.
* @return true if query is valid.
*/
@@ -425,6 +433,7 @@ public class UrlValidator implements Serializable {
* Validate scheme. If schemes[] was initialized to a non-null,
* then only those schemes are allowed. Note this is slightly different
* than for the constructor.
+ *
* @param scheme The scheme to validate. A {@code null} value is
considered
* invalid.
* @return true if valid.
diff --git a/src/main/java/org/apache/commons/validator/Validator.java
b/src/main/java/org/apache/commons/validator/Validator.java
index d9bebb63..53ca190d 100644
--- a/src/main/java/org/apache/commons/validator/Validator.java
+++ b/src/main/java/org/apache/commons/validator/Validator.java
@@ -234,6 +234,7 @@ public class Validator implements Serializable {
* {@code useContextClassLoader} property is set to true</li>
* <li>The class loader used to load the Digester class itself.</li>
* </ul>
+ *
* @return the class loader.
*/
public ClassLoader getClassLoader() {
@@ -263,6 +264,7 @@ public class Validator implements Serializable {
/**
* Gets the form name which is the key to a set of validation rules.
+ *
* @return the name of the form.
*/
public String getFormName() {
@@ -271,6 +273,7 @@ public class Validator implements Serializable {
/**
* Returns true if the Validator is only returning Fields that fail
validation.
+ *
* @return whether only failed fields are returned.
*/
public boolean getOnlyReturnErrors() {
@@ -326,6 +329,7 @@ public class Validator implements Serializable {
/**
* Gets the boolean as to whether the context classloader should be used.
+ *
* @return whether the context classloader should be used.
*/
public boolean getUseContextClassLoader() {
@@ -355,6 +359,7 @@ public class Validator implements Serializable {
/**
* Sets the form name which is the key to a set of validation rules.
+ *
* @param formName the name of the form.
*/
public void setFormName(final String formName) {
@@ -365,6 +370,7 @@ public class Validator implements Serializable {
* Configures which Fields the Validator returns from the validate()
method. Set this
* to true to only return Fields that failed validation. By default,
validate() returns
* all fields.
+ *
* @param onlyReturnErrors whether only failed fields are returned.
*/
public void setOnlyReturnErrors(final boolean onlyReturnErrors) {
diff --git a/src/main/java/org/apache/commons/validator/ValidatorResources.java
b/src/main/java/org/apache/commons/validator/ValidatorResources.java
index 02c7806d..cf869ed4 100644
--- a/src/main/java/org/apache/commons/validator/ValidatorResources.java
+++ b/src/main/java/org/apache/commons/validator/ValidatorResources.java
@@ -93,6 +93,7 @@ public class ValidatorResources implements Serializable {
/**
* {@link Map} of {@code FormSet}s stored under
* a {@link Locale} key (expressed as a String).
+ *
* @deprecated Subclasses should use getFormSets() instead.
*/
@Deprecated
@@ -101,6 +102,7 @@ public class ValidatorResources implements Serializable {
/**
* {@link Map} of global constant values with
* the name of the constant as the key.
+ *
* @deprecated Subclasses should use getConstants() instead.
*/
@Deprecated
@@ -109,6 +111,7 @@ public class ValidatorResources implements Serializable {
/**
* {@link Map} of {@code ValidatorAction}s with
* the name of the {@code ValidatorAction} as the key.
+ *
* @deprecated Subclasses should use getActions() instead.
*/
@Deprecated
@@ -234,6 +237,7 @@ public class ValidatorResources implements Serializable {
/**
* Add a global constant to the resource.
+ *
* @param name The constant name.
* @param value The constant value.
*/
@@ -249,6 +253,7 @@ public class ValidatorResources implements Serializable {
* Add a {@code FormSet} to this {@code ValidatorResources}
* object. It will be associated with the {@link Locale} of the
* {@code FormSet}.
+ *
* @param fs The form set to add.
* @since 1.1
*/
@@ -317,6 +322,7 @@ public class ValidatorResources implements Serializable {
* instance of the class based on the {@code ValidatorAction}s
* class name and retrieves the {@code Method} instance and sets them
* in the {@code ValidatorAction}.
+ *
* @param va The validator action.
*/
public void addValidatorAction(final ValidatorAction va) {
@@ -332,6 +338,7 @@ public class ValidatorResources implements Serializable {
/**
* Builds a key to store the {@code FormSet} under based on its
* language, country, and variant values.
+ *
* @param fs The Form Set.
* @return generated key for a formset.
*/
@@ -352,6 +359,7 @@ public class ValidatorResources implements Serializable {
/**
* Returns a Map of String ValidatorAction names to their ValidatorAction.
+ *
* @return Map of Validator Actions
* @since 1.2.0
*/
@@ -362,6 +370,7 @@ public class ValidatorResources implements Serializable {
/**
* Returns a Map of String constant names to their String values.
+ *
* @return Map of Constants
* @since 1.2.0
*/
@@ -380,6 +389,7 @@ public class ValidatorResources implements Serializable {
* <li>language</li>
* <li>default locale</li>
* </ol>
+ *
* @param locale The Locale.
* @param formKey The key for the Form.
* @return The validator Form.
@@ -400,6 +410,7 @@ public class ValidatorResources implements Serializable {
* <li>language</li>
* <li>default locale</li>
* </ol>
+ *
* @param language The locale's language.
* @param country The locale's country.
* @param variant The locale's language variant.
@@ -464,6 +475,7 @@ public class ValidatorResources implements Serializable {
/**
* <p>Gets a {@code FormSet} based on the language, country
* and variant.</p>
+ *
* @param language The locale's language.
* @param country The locale's country.
* @param variant The locale's language variant.
@@ -480,6 +492,7 @@ public class ValidatorResources implements Serializable {
/**
* Returns a Map of String locale keys to Lists of their FormSets.
+ *
* @return Map of Form sets
* @since 1.2.0
*/
@@ -539,6 +552,7 @@ public class ValidatorResources implements Serializable {
/**
* Gets a {@code ValidatorAction} based on its name.
+ *
* @param key The validator action key.
* @return The validator action.
*/
@@ -548,6 +562,7 @@ public class ValidatorResources implements Serializable {
/**
* Gets an unmodifiable {@link Map} of the {@code ValidatorAction}s.
+ *
* @return Map of validator actions.
*/
public Map<String, ValidatorAction> getValidatorActions() {
diff --git a/src/main/java/org/apache/commons/validator/ValidatorResult.java
b/src/main/java/org/apache/commons/validator/ValidatorResult.java
index 8ce79d71..d5f08742 100644
--- a/src/main/java/org/apache/commons/validator/ValidatorResult.java
+++ b/src/main/java/org/apache/commons/validator/ValidatorResult.java
@@ -44,6 +44,7 @@ public class ValidatorResult implements Serializable {
/**
* Constructs a Result status.
+ *
* @param valid Whether the validator passed or failed.
* @param result Value returned by the validator.
*/
@@ -68,6 +69,7 @@ public class ValidatorResult implements Serializable {
* Gets the result returned by a validation method.
* This can be used to retrieve to the correctly
* typed value of a date validation for example.
+ *
* @return The value returned by the validation.
*/
public Object getResult() {
@@ -76,6 +78,7 @@ public class ValidatorResult implements Serializable {
/**
* Tests whether or not the validation passed.
+ *
* @return true if the result was good.
*/
public boolean isValid() {
@@ -86,6 +89,7 @@ public class ValidatorResult implements Serializable {
* Sets the result returned by a validation method.
* This can be used to retrieve to the correctly
* typed value of a date validation for example.
+ *
* @param result The value returned by the validation.
*/
public void setResult(final Object result) {
@@ -94,6 +98,7 @@ public class ValidatorResult implements Serializable {
/**
* Sets whether or not the validation passed.
+ *
* @param valid Whether the validation passed.
*/
public void setValid(final boolean valid) {
@@ -119,6 +124,7 @@ public class ValidatorResult implements Serializable {
/**
* Constructs a {@code ValidatorResult} with the associated field being
* validated.
+ *
* @param field Field that was validated.
*/
public ValidatorResult(final Field field) {
@@ -127,6 +133,7 @@ public class ValidatorResult implements Serializable {
/**
* Add the result of a validator action.
+ *
* @param validatorName Name of the validator.
* @param result Whether the validation passed or failed.
*/
@@ -136,6 +143,7 @@ public class ValidatorResult implements Serializable {
/**
* Add the result of a validator action.
+ *
* @param validatorName Name of the validator.
* @param result Whether the validation passed or failed.
* @param value Value returned by the validator.
@@ -146,6 +154,7 @@ public class ValidatorResult implements Serializable {
/**
* Indicate whether a specified validator is in the Result.
+ *
* @param validatorName Name of the validator.
* @return true if the validator is in the result.
*/
@@ -155,6 +164,7 @@ public class ValidatorResult implements Serializable {
/**
* 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
@@ -167,6 +177,7 @@ public class ValidatorResult implements Serializable {
/**
* Gets an Iterator of the action names contained in this Result.
+ *
* @return The set of action names.
*/
public Iterator<String> getActions() {
@@ -175,6 +186,7 @@ public class ValidatorResult implements Serializable {
/**
* Returns the Field that was validated.
+ *
* @return The Field associated with this result.
*/
public Field getField() {
@@ -183,6 +195,7 @@ public class ValidatorResult implements Serializable {
/**
* Gets the result of a validation.
+ *
* @param validatorName Name of the validator.
* @return The validation result.
*/
@@ -193,6 +206,7 @@ public class ValidatorResult implements Serializable {
/**
* Indicate whether a specified validation passed.
+ *
* @param validatorName Name of the validator.
* @return true if the validation passed.
*/
diff --git a/src/main/java/org/apache/commons/validator/ValidatorResults.java
b/src/main/java/org/apache/commons/validator/ValidatorResults.java
index 7dd2f336..b03325e1 100644
--- a/src/main/java/org/apache/commons/validator/ValidatorResults.java
+++ b/src/main/java/org/apache/commons/validator/ValidatorResults.java
@@ -89,6 +89,7 @@ public class ValidatorResults implements Serializable {
/**
* Gets the set of property names for which at least one message has
* been recorded.
+ *
* @return An unmodifiable Set of the property names.
*/
public Set<String> getPropertyNames() {
diff --git a/src/main/java/org/apache/commons/validator/Var.java
b/src/main/java/org/apache/commons/validator/Var.java
index 59fffc85..4bf57ef9 100644
--- a/src/main/java/org/apache/commons/validator/Var.java
+++ b/src/main/java/org/apache/commons/validator/Var.java
@@ -79,6 +79,7 @@ public class Var implements Cloneable, Serializable {
/**
* Constructs a variable with a specified name, value
* and JavaScript type.
+ *
* @param name Variable name.
* @param value Variable value.
* @param jsType Variable JavaScript type.
@@ -91,6 +92,7 @@ public class Var implements Cloneable, Serializable {
/**
* Creates and returns a copy of this object.
+ *
* @return A copy of the variable.
*/
@Override
@@ -105,6 +107,7 @@ public class Var implements Cloneable, Serializable {
/**
* Returns the resource bundle name.
+ *
* @return The bundle name.
* @since 1.2.0
*/
@@ -114,6 +117,7 @@ public class Var implements Cloneable, Serializable {
/**
* Gets the JavaScript type of the variable.
+ *
* @return The JavaScript type of the variable.
*/
public String getJsType() {
@@ -122,6 +126,7 @@ public class Var implements Cloneable, Serializable {
/**
* Gets the name of the variable.
+ *
* @return The name of the variable.
*/
public String getName() {
@@ -130,6 +135,7 @@ public class Var implements Cloneable, Serializable {
/**
* Gets the value of the variable.
+ *
* @return The value of the variable.
*/
public String getValue() {
@@ -138,6 +144,7 @@ public class Var implements Cloneable, Serializable {
/**
* Tests whether or not the value is a resource key or literal value.
+ *
* @return {@code true} if value is a resource key.
* @since 1.2.0
*/
@@ -147,6 +154,7 @@ public class Var implements Cloneable, Serializable {
/**
* Sets the resource bundle name.
+ *
* @param bundle The new bundle name.
* @since 1.2.0
*/
@@ -156,6 +164,7 @@ public class Var implements Cloneable, Serializable {
/**
* Sets the JavaScript type of the variable.
+ *
* @param jsType The JavaScript type of the variable.
*/
public void setJsType(final String jsType) {
@@ -164,6 +173,7 @@ public class Var implements Cloneable, Serializable {
/**
* Sets the name of the variable.
+ *
* @param name The name of the variable.
*/
public void setName(final String name) {
@@ -172,6 +182,7 @@ public class Var implements Cloneable, Serializable {
/**
* Sets whether or not the value is a resource.
+ *
* @param resource If true indicates the value is a resource.
* @since 1.2.0
*/
@@ -181,6 +192,7 @@ public class Var implements Cloneable, Serializable {
/**
* Sets the value of the variable.
+ *
* @param value The value of the variable.
*/
public void setValue(final String value) {
@@ -189,6 +201,7 @@ public class Var implements Cloneable, Serializable {
/**
* Returns a string representation of the object.
+ *
* @return A string representation of the variable.
*/
@Override
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 8f2589bc..f5617bd2 100644
---
a/src/main/java/org/apache/commons/validator/routines/BigDecimalValidator.java
+++
b/src/main/java/org/apache/commons/validator/routines/BigDecimalValidator.java
@@ -73,6 +73,7 @@ public class BigDecimalValidator extends
AbstractNumberValidator {
/**
* 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 92eeaf56..02c1e4a9 100644
---
a/src/main/java/org/apache/commons/validator/routines/BigIntegerValidator.java
+++
b/src/main/java/org/apache/commons/validator/routines/BigIntegerValidator.java
@@ -71,6 +71,7 @@ public class BigIntegerValidator extends
AbstractNumberValidator {
/**
* 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 c61db6fd..253a9567 100644
--- a/src/main/java/org/apache/commons/validator/routines/ByteValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/ByteValidator.java
@@ -70,6 +70,7 @@ public class ByteValidator extends AbstractNumberValidator {
/**
* 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 fab62867..5e22ca33 100644
--- a/src/main/java/org/apache/commons/validator/routines/CalendarValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/CalendarValidator.java
@@ -112,6 +112,7 @@ public class CalendarValidator extends
AbstractCalendarValidator {
/**
* 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/CreditCardValidator.java
b/src/main/java/org/apache/commons/validator/routines/CreditCardValidator.java
index 1d796317..39d6ae78 100644
---
a/src/main/java/org/apache/commons/validator/routines/CreditCardValidator.java
+++
b/src/main/java/org/apache/commons/validator/routines/CreditCardValidator.java
@@ -85,6 +85,7 @@ public class CreditCardValidator implements Serializable {
/**
* Class that represents a credit card range.
+ *
* @since 1.6
*/
public static class CreditCardRange {
@@ -106,6 +107,7 @@ public class CreditCardValidator implements Serializable {
* The low and high parameters may be different lengths.
* for example, Discover "644" and "65".
* </p>
+ *
* @param low the low digits of the IIN range
* @param high the high digits of the IIN range
* @param minLen the minimum length of the entire number
@@ -131,6 +133,7 @@ public class CreditCardValidator implements Serializable {
* The low and high parameters may be different lengths.
* for example, Discover "644" and "65".
* </p>
+ *
* @param low the low digits of the IIN range
* @param high the high digits of the IIN range
* @param lengths array of valid lengths
@@ -192,12 +195,14 @@ public class CreditCardValidator implements Serializable {
/**
* Option specifying that VPay (Visa) cards are allowed.
+ *
* @since 1.5.0
*/
public static final long VPAY = 1 << 5; // CHECKSTYLE IGNORE MagicNumber
/**
* Option specifying that Mastercard cards (pre Oct 2016 only) are allowed.
+ *
* @deprecated for use until Oct 2016 only
*/
@Deprecated
@@ -264,6 +269,7 @@ public class CreditCardValidator implements Serializable {
/**
* Mastercard Card Validator (pre Oct 2016)
+ *
* @deprecated for use until Oct 2016 only
*/
@Deprecated
@@ -282,6 +288,7 @@ public class CreditCardValidator implements Serializable {
* <p>
* 4xxxxx (13-19)
* </p>
+ *
* @since 1.5.0
*/
public static final CodeValidator VPAY_VALIDATOR = new
CodeValidator("^(4)(\\d{12,18})$", LUHN_VALIDATOR);
@@ -394,6 +401,7 @@ public class CreditCardValidator implements Serializable {
/**
* Constructs a new CreditCardValidator with the specified {@link
CodeValidator}s.
+ *
* @param creditCardValidators Set of valid code validators
*/
public CreditCardValidator(final CodeValidator[] creditCardValidators) {
@@ -409,6 +417,7 @@ public class CreditCardValidator implements Serializable {
* <p>
* This can be used to combine predefined validators such as {@link
#MASTERCARD_VALIDATOR}
* with additional validators using the simpler {@link CreditCardRange}s.
+ *
* @param creditCardValidators Set of valid code validators
* @param creditCardRanges Set of valid code validators
* @since 1.6
@@ -426,6 +435,7 @@ public class CreditCardValidator implements Serializable {
/**
* Constructs a new CreditCardValidator with the specified {@link
CreditCardRange}s.
+ *
* @param creditCardRanges Set of valid code validators
* @since 1.6
*/
@@ -438,6 +448,7 @@ public class CreditCardValidator implements Serializable {
/**
* Constructs a new CreditCardValidator with the specified options.
+ *
* @param options Pass in
* CreditCardValidator.VISA + CreditCardValidator.AMEX to specify that
* those are the only valid card types.
@@ -486,6 +497,7 @@ public class CreditCardValidator implements Serializable {
/**
* Checks if the field is a valid credit card number.
+ *
* @param card The card number to validate.
* @return Whether the card number is valid.
*/
@@ -503,6 +515,7 @@ public class CreditCardValidator implements Serializable {
/**
* Checks if the field is a valid credit card number.
+ *
* @param card The card number to validate.
* @return The card number if valid or {@code null}
* if invalid.
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 6a314aa9..16ad0a0c 100644
--- a/src/main/java/org/apache/commons/validator/routines/CurrencyValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/CurrencyValidator.java
@@ -52,6 +52,7 @@ public class CurrencyValidator extends BigDecimalValidator {
/**
* 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 095b3cc4..d558b498 100644
--- a/src/main/java/org/apache/commons/validator/routines/DateValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/DateValidator.java
@@ -89,6 +89,7 @@ public class DateValidator extends AbstractCalendarValidator {
/**
* 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/DomainValidator.java
b/src/main/java/org/apache/commons/validator/routines/DomainValidator.java
index 1487e82e..99572e14 100644
--- a/src/main/java/org/apache/commons/validator/routines/DomainValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/DomainValidator.java
@@ -66,6 +66,7 @@ public class DomainValidator implements Serializable {
/**
* Enum used by {@link DomainValidator#updateTLDOverride(ArrayType,
String[])}
* to determine which override array to update / fetch
+ *
* @since 1.5.0
* @since 1.5.1 made public and added read-only array references
*/
@@ -88,11 +89,13 @@ public class DomainValidator implements Serializable {
LOCAL_RO,
/**
* Update (or get a copy of) the LOCAL_TLDS_PLUS table containing
additional local TLDs
+ *
* @since 1.7
*/
LOCAL_PLUS,
/**
* Update (or get a copy of) the LOCAL_TLDS_MINUS table containing
deleted local TLDs
+ *
* @since 1.7
*/
LOCAL_MINUS
@@ -118,6 +121,7 @@ public class DomainValidator implements Serializable {
/**
* Constructs a new instance.
+ *
* @param type ArrayType, for example, GENERIC_PLUS, LOCAL_PLUS
* @param values array of TLDs. Will be lower-cased and sorted
*/
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 3e73c087..b28f2065 100644
--- a/src/main/java/org/apache/commons/validator/routines/DoubleValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/DoubleValidator.java
@@ -70,6 +70,7 @@ public class DoubleValidator extends AbstractNumberValidator {
/**
* 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 221f2591..1c163207 100644
--- a/src/main/java/org/apache/commons/validator/routines/FloatValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/FloatValidator.java
@@ -70,6 +70,7 @@ public class FloatValidator extends AbstractNumberValidator {
/**
* 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 00e79f91..3e6e72dd 100644
--- a/src/main/java/org/apache/commons/validator/routines/IBANValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/IBANValidator.java
@@ -56,6 +56,7 @@ import
org.apache.commons.validator.routines.checkdigit.IBANCheckDigit;
* <p>
* The singleton default instance cannot be modified in this way.
* </p>
+ *
* @since 1.5.0
*/
public class IBANValidator {
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 7584e5b0..0947fec3 100644
--- a/src/main/java/org/apache/commons/validator/routines/ISSNValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/ISSNValidator.java
@@ -59,6 +59,7 @@ import
org.apache.commons.validator.routines.checkdigit.ISSNCheckDigit;
* some_method(valid.toString());
* }
* </pre>
+ *
* @since 1.5.0
*/
public class ISSNValidator implements Serializable {
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 1bdd721e..5f75813d 100644
--- a/src/main/java/org/apache/commons/validator/routines/IntegerValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/IntegerValidator.java
@@ -70,6 +70,7 @@ public class IntegerValidator extends AbstractNumberValidator
{
/**
* 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 9d4d9d94..2cc4685b 100644
--- a/src/main/java/org/apache/commons/validator/routines/LongValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/LongValidator.java
@@ -69,6 +69,7 @@ public class LongValidator extends AbstractNumberValidator {
/**
* 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 a0b78f1e..02278da7 100644
--- a/src/main/java/org/apache/commons/validator/routines/PercentValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/PercentValidator.java
@@ -57,6 +57,7 @@ public class PercentValidator extends BigDecimalValidator {
/**
* 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 0ecb93ce..b50ae350 100644
--- a/src/main/java/org/apache/commons/validator/routines/ShortValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/ShortValidator.java
@@ -70,6 +70,7 @@ public class ShortValidator extends AbstractNumberValidator {
/**
* 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 21540499..41e9c1fd 100644
--- a/src/main/java/org/apache/commons/validator/routines/TimeValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/TimeValidator.java
@@ -89,6 +89,7 @@ public class TimeValidator extends AbstractCalendarValidator {
/**
* 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/UrlValidator.java
b/src/main/java/org/apache/commons/validator/routines/UrlValidator.java
index 3b3fa134..44862bcc 100644
--- a/src/main/java/org/apache/commons/validator/routines/UrlValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/UrlValidator.java
@@ -163,6 +163,7 @@ public class UrlValidator implements Serializable {
/**
* Returns the singleton instance of this class with default schemes and
options.
+ *
* @return singleton instance with default schemes and options
*/
public static UrlValidator getInstance() {
@@ -211,6 +212,7 @@ public class UrlValidator implements Serializable {
/**
* Constructs a new instance with the given validation options.
+ *
* @param options The options should be set using the public constants
declared in
* this class. To set multiple options you simply add them together. For
example,
* ALLOW_2_SLASHES + NO_FRAGMENTS enables both of those options.
@@ -221,6 +223,7 @@ public class UrlValidator implements Serializable {
/**
* Constructs a new instance with the given validation options.
+ *
* @param authorityValidator Regular expression validator used to validate
the authority part
* This allows the user to override the standard set of domains.
* @param options Validation options. Set using the public constants of
this class.
@@ -234,6 +237,7 @@ public class UrlValidator implements Serializable {
/**
* Behavior of validation is modified by passing in several strings
options:
+ *
* @param schemes Pass in one or more URL schemes to consider valid,
passing in
* a null will default to "http,https,ftp" being valid.
* If a non-null schemes is specified then all valid schemes must
@@ -246,6 +250,7 @@ public class UrlValidator implements Serializable {
/**
* Behavior of validation is modified by passing in options:
+ *
* @param schemes The set of valid schemes. Ignored if the
ALLOW_ALL_SCHEMES option is set.
* @param options The options should be set using the public constants
declared in
* this class. To set multiple options you simply add them together. For
example,
@@ -257,6 +262,7 @@ public class UrlValidator implements Serializable {
/**
* Customizable constructor. Validation behavior is modified by passing in
options.
+ *
* @param schemes the set of valid schemes. Ignored if the
ALLOW_ALL_SCHEMES option is set.
* @param authorityValidator Regular expression validator used to validate
the authority part
* @param options Validation options. Set using the public constants of
this class.
@@ -270,6 +276,7 @@ public class UrlValidator implements Serializable {
/**
* Customizable constructor. Validation behavior is modified by passing in
options.
+ *
* @param schemes the set of valid schemes. Ignored if the
ALLOW_ALL_SCHEMES option is set.
* @param authorityValidator Regular expression validator used to validate
the authority part
* @param options Validation options. Set using the public constants of
this class.
@@ -306,6 +313,7 @@ public class UrlValidator implements Serializable {
/**
* Returns the number of times the token appears in the target.
+ *
* @param token Token value to be counted.
* @param target Target value to count tokens in.
* @return the number of tokens.
@@ -391,6 +399,7 @@ public class UrlValidator implements Serializable {
* If a RegexValidator was supplied, and it matches, then the authority is
regarded
* as valid with no further checks, otherwise the method checks against the
* AUTHORITY_PATTERN and the DomainValidator (ALLOW_LOCAL_URLS)
+ *
* @param authority Authority value to validate, allows IDN
* @return true if authority (hostname and port) is valid.
*/
@@ -453,6 +462,7 @@ public class UrlValidator implements Serializable {
/**
* Returns true if the given fragment is null or fragments are allowed.
+ *
* @param fragment Fragment value to validate.
* @return true if fragment is valid.
*/
@@ -466,6 +476,7 @@ public class UrlValidator implements Serializable {
/**
* Returns true if the path is valid. A {@code null} value is considered
invalid.
+ *
* @param path Path value to validate.
* @return true if path is valid.
*/
@@ -496,6 +507,7 @@ public class UrlValidator implements Serializable {
/**
* Returns true if the query is null, or it's a properly formatted query
string.
+ *
* @param query Query value to validate.
* @return true if query is valid.
*/
@@ -511,6 +523,7 @@ public class UrlValidator implements Serializable {
* then only those schemes are allowed.
* Otherwise, the default schemes are "http", "https", "ftp".
* Matching is case-blind.
+ *
* @param scheme The scheme to validate. A {@code null} value is
considered
* invalid.
* @return true if valid.
diff --git
a/src/main/java/org/apache/commons/validator/routines/checkdigit/CASNumberCheckDigit.java
b/src/main/java/org/apache/commons/validator/routines/checkdigit/CASNumberCheckDigit.java
index 06cb787a..4724007a 100644
---
a/src/main/java/org/apache/commons/validator/routines/checkdigit/CASNumberCheckDigit.java
+++
b/src/main/java/org/apache/commons/validator/routines/checkdigit/CASNumberCheckDigit.java
@@ -73,6 +73,7 @@ public final class CASNumberCheckDigit extends
ModulusCheckDigit {
/**
* Gets the singleton instance of this validator.
+ *
* @return A singleton instance of the CAS Number validator.
*/
public static CheckDigit getInstance() {
diff --git
a/src/main/java/org/apache/commons/validator/routines/checkdigit/ECNumberCheckDigit.java
b/src/main/java/org/apache/commons/validator/routines/checkdigit/ECNumberCheckDigit.java
index 36cb14a1..a0061464 100644
---
a/src/main/java/org/apache/commons/validator/routines/checkdigit/ECNumberCheckDigit.java
+++
b/src/main/java/org/apache/commons/validator/routines/checkdigit/ECNumberCheckDigit.java
@@ -60,6 +60,7 @@ public final class ECNumberCheckDigit extends
ModulusCheckDigit {
static final CodeValidator REGEX_VALIDATOR = new CodeValidator(EC_REGEX,
EC_LEN, null);
/**
* Gets the singleton instance of this validator.
+ *
* @return A singleton instance of the EC Number validator.
*/
public static CheckDigit getInstance() {
diff --git
a/src/main/java/org/apache/commons/validator/routines/checkdigit/ISSNCheckDigit.java
b/src/main/java/org/apache/commons/validator/routines/checkdigit/ISSNCheckDigit.java
index 6f9c390c..d7c6dc03 100644
---
a/src/main/java/org/apache/commons/validator/routines/checkdigit/ISSNCheckDigit.java
+++
b/src/main/java/org/apache/commons/validator/routines/checkdigit/ISSNCheckDigit.java
@@ -44,6 +44,7 @@ package org.apache.commons.validator.routines.checkdigit;
* 03178471
* 1050124X
* </pre>
+ *
* @since 1.5.0
*/
public final class ISSNCheckDigit extends ModulusCheckDigit {
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 523881f6..29a5b266 100644
--- a/src/main/java/org/apache/commons/validator/util/Flags.java
+++ b/src/main/java/org/apache/commons/validator/util/Flags.java
@@ -62,6 +62,7 @@ public class Flags implements Serializable, Cloneable {
/**
* Turn off all flags. This is a synonym for {@code turnOffAll()}.
+ *
* @since 1.1.1
*/
public void clear() {
@@ -85,6 +86,7 @@ public class Flags implements Serializable, Cloneable {
/**
* Tests if two Flags objects are in the same state.
+ *
* @param obj object being tested
* @see Object#equals(Object)
* @return whether the objects are equal.
@@ -112,6 +114,7 @@ public class Flags implements Serializable, Cloneable {
/**
* The hash code is based on the current state of the flags.
+ *
* @see Object#hashCode()
* @return the hash code for this object.
*/
