From a85f2b63520113a337b9fdb3cc8c90beea8ed66e Mon Sep 17 00:00:00 2001 From: Gary Gregory Date: Fri, 15 Nov 2024 11:54:48 -0500 Subject: [PATCH] Javadoc: Use semantic tag instead of style tag --- .../commons/validator/ISBNValidator.java | 2 +- .../commons/validator/ValidatorAction.java | 2 +- .../routines/BigDecimalValidator.java | 2 +- .../routines/BigIntegerValidator.java | 2 +- .../validator/routines/ByteValidator.java | 2 +- .../validator/routines/CalendarValidator.java | 2 +- .../validator/routines/CodeValidator.java | 12 +++--- .../validator/routines/CurrencyValidator.java | 2 +- .../validator/routines/DateValidator.java | 2 +- .../validator/routines/DomainValidator.java | 4 +- .../validator/routines/DoubleValidator.java | 2 +- .../validator/routines/FloatValidator.java | 2 +- .../validator/routines/ISBNValidator.java | 2 +- .../validator/routines/ISINValidator.java | 2 +- .../routines/InetAddressValidator.java | 2 +- .../validator/routines/IntegerValidator.java | 2 +- .../validator/routines/LongValidator.java | 2 +- .../validator/routines/PercentValidator.java | 2 +- .../validator/routines/RegexValidator.java | 4 +- .../validator/routines/ShortValidator.java | 2 +- .../validator/routines/TimeValidator.java | 2 +- .../validator/routines/UrlValidator.java | 2 +- .../checkdigit/ABANumberCheckDigit.java | 2 +- .../checkdigit/CASNumberCheckDigit.java | 2 +- .../routines/checkdigit/CUSIPCheckDigit.java | 8 ++-- .../routines/checkdigit/CheckDigit.java | 2 +- .../routines/checkdigit/EAN13CheckDigit.java | 8 ++-- .../checkdigit/ECNumberCheckDigit.java | 2 +- .../routines/checkdigit/IBANCheckDigit.java | 4 +- .../routines/checkdigit/ISBN10CheckDigit.java | 4 +- .../routines/checkdigit/ISBNCheckDigit.java | 4 +- .../routines/checkdigit/ISINCheckDigit.java | 8 ++-- .../routines/checkdigit/ISSNCheckDigit.java | 2 +- .../routines/checkdigit/LuhnCheckDigit.java | 8 ++-- .../checkdigit/ModulusCheckDigit.java | 8 ++-- .../checkdigit/ModulusTenCheckDigit.java | 14 +++---- .../routines/checkdigit/SedolCheckDigit.java | 2 +- .../checkdigit/VerhoeffCheckDigit.java | 2 +- .../routines/checkdigit/package-info.java | 2 +- .../validator/routines/package-info.java | 38 +++++++++---------- .../apache/commons/validator/EmailTest.java | 2 +- 41 files changed, 90 insertions(+), 90 deletions(-) diff --git a/src/main/java/org/apache/commons/validator/ISBNValidator.java b/src/main/java/org/apache/commons/validator/ISBNValidator.java index 06631d6ac..62b74d17f 100644 --- a/src/main/java/org/apache/commons/validator/ISBNValidator.java +++ b/src/main/java/org/apache/commons/validator/ISBNValidator.java @@ -22,7 +22,7 @@ * * algorithm * - * NOTE: This has been replaced by the new + * NOTE: This has been replaced by the new * {@link org.apache.commons.validator.routines.ISBNValidator}. * * @since 1.2.0 diff --git a/src/main/java/org/apache/commons/validator/ValidatorAction.java b/src/main/java/org/apache/commons/validator/ValidatorAction.java index afa1d6b49..1dcf6c7a1 100644 --- a/src/main/java/org/apache/commons/validator/ValidatorAction.java +++ b/src/main/java/org/apache/commons/validator/ValidatorAction.java @@ -665,7 +665,7 @@ public synchronized void setJavascript(final String javaScript) { *

* * 
-     * Examples
+     * Examples
      *   If in the validator.xml :
      * #1:
      *      <validator name="tire"
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 1eac98445..17e09dbb5 100644
--- a/src/main/java/org/apache/commons/validator/routines/BigDecimalValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/BigDecimalValidator.java
@@ -22,7 +22,7 @@
 import java.util.Locale;
 
 /**
- * 
BigDecimal Validation and Conversion routines ({@code java.math.BigDecimal}).

+ * 
BigDecimal Validation and Conversion routines ({@code java.math.BigDecimal}).

  *
  * 
This validator provides a number of methods for
  *    validating/converting a {@link String} value to
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 41d1255ff..3426d8102 100644
--- a/src/main/java/org/apache/commons/validator/routines/BigIntegerValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/BigIntegerValidator.java
@@ -22,7 +22,7 @@
 import java.util.Locale;
 
 /**
- * 
BigInteger Validation and Conversion routines ({@code java.math.BigInteger}).

+ * 
BigInteger Validation and Conversion routines ({@code java.math.BigInteger}).

  *
  * 
This validator provides a number of methods for
  *    validating/converting a {@link String} value to
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 4b89fb2e5..c8fa49eb8 100644
--- a/src/main/java/org/apache/commons/validator/routines/ByteValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/ByteValidator.java
@@ -21,7 +21,7 @@
 import java.util.Locale;
 
 /**
- * 
Byte Validation and Conversion routines ({@code java.lang.Byte}).

+ * 
Byte Validation and Conversion routines ({@code java.lang.Byte}).

  *
  * 
This validator provides a number of methods for
  *    validating/converting a {@link String} value to
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 293542ba5..97dd3ba63 100644
--- a/src/main/java/org/apache/commons/validator/routines/CalendarValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/CalendarValidator.java
@@ -23,7 +23,7 @@
 import java.util.TimeZone;
 
 /**
- * 
Calendar Validation and Conversion routines ({@code java.util.Calendar}).

+ * 
Calendar Validation and Conversion routines ({@code java.util.Calendar}).

  *
  * 
This validator provides a number of methods for validating/converting
  *    a {@link String} date value to a {@code java.util.Calendar} using
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 287916818..adac0e355 100644
--- a/src/main/java/org/apache/commons/validator/routines/CodeValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/CodeValidator.java
@@ -22,7 +22,7 @@
 import org.apache.commons.validator.routines.checkdigit.CheckDigit;
 
 /**
- * Generic Code Validation providing format, minimum/maximum
+ * Generic Code Validation providing format, minimum/maximum
  * length and {@link CheckDigit} validations.
  * 

  * Performs the following validations on a code:
@@ -36,7 +36,7 @@
  *   
  • The {@link #validate(String)} method returns the trimmed, parsed input (or null if validation failed)
    • 
  * 
  * 
    
- * Note
+ * Note
  * The {@link #isValid(String)} method will return true if the input passes validation.
  * Since this includes trimming as well as potentially dropping parts of the input,
  * it is possible for a String to pass validation
@@ -171,7 +171,7 @@ public CodeValidator(final String regex, final int minLength, final int maxLengt
     /**
      * Gets the check digit validation routine.
      * 
    
-     * N.B. Optional, if not set no Check Digit
+     * N.B. Optional, if not set no Check Digit
      * validation will be performed on the code.
      *
      * @return The check digit validation routine
@@ -183,7 +183,7 @@ public CheckDigit getCheckDigit() {
     /**
      * Gets the maximum length of the code.
      * 
    
-     * N.B. Optional, if less than zero the
+     * N.B. Optional, if less than zero the
      * maximum length will not be checked.
      *
      * @return The maximum length of the code or
@@ -196,7 +196,7 @@ public int getMaxLength() {
     /**
      * Gets the minimum length of the code.
      * 
    
-     * N.B. Optional, if less than zero the
+     * N.B. Optional, if less than zero the
      * minimum length will not be checked.
      *
      * @return The minimum length of the code or
@@ -209,7 +209,7 @@ public int getMinLength() {
     /**
      * Gets the regular expression validator.
      * 
    
-     * N.B. Optional, if not set no regular
+     * N.B. Optional, if not set no regular
      * expression validation will be performed on the code.
      *
      * @return The regular expression validator
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 ac9f1be20..46812d029 100644
--- a/src/main/java/org/apache/commons/validator/routines/CurrencyValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/CurrencyValidator.java
@@ -20,7 +20,7 @@
 import java.text.Format;
 
 /**
- * 
    Currency Validation and Conversion routines ({@code java.math.BigDecimal}).
    
+ * 
    Currency Validation and Conversion routines ({@code java.math.BigDecimal}).
    
  *
  * 
    This is one implementation of a currency validator that has the following features:
    
  *    
      
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 d0c48675a..054a286de 100644
--- a/src/main/java/org/apache/commons/validator/routines/DateValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/DateValidator.java
@@ -24,7 +24,7 @@
 import java.util.TimeZone;
 
 /**
- * 
      Date Validation and Conversion routines ({@code java.util.Date}).
      
+ * 
      Date Validation and Conversion routines ({@code java.util.Date}).
      
  *
  * 
      This validator provides a number of methods for validating/converting
  *    a {@link String} date value to a {@code java.util.Date} using
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 2b83061dd..a9b0d9866 100644
--- a/src/main/java/org/apache/commons/validator/routines/DomainValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/DomainValidator.java
@@ -23,7 +23,7 @@
 import java.util.Locale;
 
 /**
- * 
      Domain name validation routines.
      
+ * 
      Domain name validation routines.
      
  *
  * 
      
  * This validator provides methods for validating Internet domain names
@@ -54,7 +54,7 @@
  *   
    
  *
  * 
    
- * (NOTE: This class does not provide IP address lookup for domain names or
+ * (NOTE: This class does not provide IP address lookup for domain names or
  * methods to ensure that a given domain name matches a specific IP; see
  * {@link java.net.InetAddress} for that functionality.)
  * 
    
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 a34eeee38..fc7baa428 100644
--- a/src/main/java/org/apache/commons/validator/routines/DoubleValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/DoubleValidator.java
@@ -21,7 +21,7 @@
 import java.util.Locale;
 
 /**
- * 
    Double Validation and Conversion routines ({@code java.lang.Double}).
    
+ * 
    Double Validation and Conversion routines ({@code java.lang.Double}).
    
  *
  * 
    This validator provides a number of methods for
  *    validating/converting a {@link String} value to
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 cbaf259dd..5930e514f 100644
--- a/src/main/java/org/apache/commons/validator/routines/FloatValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/FloatValidator.java
@@ -21,7 +21,7 @@
 import java.util.Locale;
 
 /**
- * 
    Float Validation and Conversion routines ({@code java.lang.Float}).
    
+ * 
    Float Validation and Conversion routines ({@code java.lang.Float}).
    
  *
  * 
    This validator provides a number of methods for
  *    validating/converting a {@link String} value to
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 58269e839..56ab6997a 100644
--- a/src/main/java/org/apache/commons/validator/routines/ISBNValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/ISBNValidator.java
@@ -24,7 +24,7 @@
 import org.apache.commons.validator.routines.checkdigit.ISBN10CheckDigit;
 
 /**
- * ISBN-10 and ISBN-13 Code Validation.
+ * ISBN-10 and ISBN-13 Code Validation.
  * 
    
  * This validator validates the code is either a valid ISBN-10
  * (using a {@link CodeValidator} with the {@link ISBN10CheckDigit})
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 6bd6e477e..91ff814c0 100644
--- a/src/main/java/org/apache/commons/validator/routines/ISINValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/ISINValidator.java
@@ -23,7 +23,7 @@
 import org.apache.commons.validator.routines.checkdigit.ISINCheckDigit;
 
 /**
- * ISIN (International Securities Identifying Number) validation.
+ * ISIN (International Securities Identifying Number) validation.
  *
  * 
    
  * ISIN Numbers are 12 character alphanumeric codes used to identify Securities.
diff --git a/src/main/java/org/apache/commons/validator/routines/InetAddressValidator.java b/src/main/java/org/apache/commons/validator/routines/InetAddressValidator.java
index 868c251db..ac3c3986f 100644
--- a/src/main/java/org/apache/commons/validator/routines/InetAddressValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/InetAddressValidator.java
@@ -26,7 +26,7 @@
 import org.apache.commons.validator.GenericValidator;
 
 /**
- * 
    InetAddress validation and conversion routines ({@code java.net.InetAddress}).
    
+ * 
    InetAddress validation and conversion routines ({@code java.net.InetAddress}).
    
  *
  * 
    This class provides methods to validate a candidate IP address.
  *
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 5fbb32c2e..45f08773f 100644
--- a/src/main/java/org/apache/commons/validator/routines/IntegerValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/IntegerValidator.java
@@ -21,7 +21,7 @@
 import java.util.Locale;
 
 /**
- * 
    Integer Validation and Conversion routines ({@code java.lang.Integer}).
    
+ * 
    Integer Validation and Conversion routines ({@code java.lang.Integer}).
    
  *
  * 
    This validator provides a number of methods for
  *    validating/converting a {@link String} value to
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 542459333..53d824bce 100644
--- a/src/main/java/org/apache/commons/validator/routines/LongValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/LongValidator.java
@@ -21,7 +21,7 @@
 import java.util.Locale;
 
 /**
- * 
    Long Validation and Conversion routines ({@code java.lang.Long}).
    
+ * 
    Long Validation and Conversion routines ({@code java.lang.Long}).
    
  *
  * 
    This validator provides a number of methods for
  *    validating/converting a {@link String} value to
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 be7cd5061..d0feb0cd5 100644
--- a/src/main/java/org/apache/commons/validator/routines/PercentValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/PercentValidator.java
@@ -21,7 +21,7 @@
 import java.text.Format;
 
 /**
- * 
    Percentage Validation and Conversion routines ({@code java.math.BigDecimal}).
    
+ * 
    Percentage Validation and Conversion routines ({@code java.math.BigDecimal}).
    
  *
  * 
    This is one implementation of a percent validator that has the following features:
    
  *    
      
diff --git a/src/main/java/org/apache/commons/validator/routines/RegexValidator.java b/src/main/java/org/apache/commons/validator/routines/RegexValidator.java
index 9e05a5427..1d87ca94f 100644
--- a/src/main/java/org/apache/commons/validator/routines/RegexValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/RegexValidator.java
@@ -22,7 +22,7 @@
 import java.util.regex.Pattern;
 
 /**
- * Regular Expression validation (using the JRE's regular expression support).
+ * Regular Expression validation (using the JRE's regular expression support).
  * 
      
  * Constructs the validator either for a single regular expression or a set (array) of regular expressions. By default validation is case sensitive but
  * constructors are provided to allow case in-sensitive validation. For example to create a validator which does case in-sensitive validation
@@ -57,7 +57,7 @@
  * 
  * 
    
  *
- * Note that patterns are matched against the entire input.
+ * Note that patterns are matched against the entire input.
  *
  * 
    
  * Cached instances pre-compile and re-use {@link Pattern}(s) - which according to the {@link Pattern} API are safe to use in a multi-threaded environment.
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 79e756b52..9560e6528 100644
--- a/src/main/java/org/apache/commons/validator/routines/ShortValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/ShortValidator.java
@@ -21,7 +21,7 @@
 import java.util.Locale;
 
 /**
- * 
    Short Validation and Conversion routines ({@code java.lang.Short}).
    
+ * 
    Short Validation and Conversion routines ({@code java.lang.Short}).
    
  *
  * 
    This validator provides a number of methods for
  *    validating/converting a {@link String} value to
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 d6c92b5c2..fab7c198a 100644
--- a/src/main/java/org/apache/commons/validator/routines/TimeValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/TimeValidator.java
@@ -23,7 +23,7 @@
 import java.util.TimeZone;
 
 /**
- * 
    Time Validation and Conversion routines ({@code java.util.Calendar}).
    
+ * 
    Time Validation and Conversion routines ({@code java.util.Calendar}).
    
  *
  * 
    This validator provides a number of methods for validating/converting
  *    a {@link String} time value to a {@code java.util.Calendar} using
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 600becfb3..c0f35f90c 100644
--- a/src/main/java/org/apache/commons/validator/routines/UrlValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/UrlValidator.java
@@ -29,7 +29,7 @@
 import org.apache.commons.validator.GenericValidator;
 
 /**
- * 
    URL Validation routines.
    
+ * 
    URL Validation routines.
    
  * Behavior of validation is modified by passing in options:
  * 
      
  * 
    • ALLOW_2_SLASHES - [FALSE]  Allows double '/' characters in the path
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 e1a6eacde..42853b097 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
@@ -17,7 +17,7 @@
 package org.apache.commons.validator.routines.checkdigit;
 
 /**
- * Modulus 10 ABA Number (or Routing Transit Number (RTN)) Check Digit
+ * Modulus 10 ABA Number (or Routing Transit Number (RTN)) Check Digit
  * calculation/validation.
  *
  * 
      
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 5daa80693..6f0e68dce 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
@@ -20,7 +20,7 @@
 import org.apache.commons.validator.routines.CodeValidator;
 
 /**
- * Modulus 10 CAS Registry Number (or Chemical Abstracts Service (CAS RN)) Check Digit
+ * Modulus 10 CAS Registry Number (or Chemical Abstracts Service (CAS RN)) Check Digit
  * calculation/validation.
  *
  * 
      
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 b0c589bd0..59fda8197 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
@@ -17,7 +17,7 @@
 package org.apache.commons.validator.routines.checkdigit;
 
 /**
- * Modulus 10 CUSIP (North American Securities) Check Digit calculation/validation.
+ * Modulus 10 CUSIP (North American Securities) Check Digit calculation/validation.
  *
  * 
      
  * CUSIP Numbers are 9 character alphanumeric codes used
@@ -80,9 +80,9 @@ protected int toInt(final char character, final int leftPos, final int rightPos)
      * 
      Calculates the weighted value of a character in the
      * code at a specified position.
      
      *
-     * 
      For CUSIP (from right to left) odd digits are weighted
-     * with a factor of one and even digits with a factor
-     * of two. Weighted values > 9, have 9 subtracted
      
+     * 
      For CUSIP (from right to left) odd digits are weighted
+     * with a factor of one and even digits with a factor
+     * of two. Weighted values > 9, have 9 subtracted
      
      *
      * @param charValue The numeric value of the character.
      * @param leftPos The position of the character in the code, counting from left to right
diff --git a/src/main/java/org/apache/commons/validator/routines/checkdigit/CheckDigit.java b/src/main/java/org/apache/commons/validator/routines/checkdigit/CheckDigit.java
index 4c571db21..931e3a18a 100644
--- a/src/main/java/org/apache/commons/validator/routines/checkdigit/CheckDigit.java
+++ b/src/main/java/org/apache/commons/validator/routines/checkdigit/CheckDigit.java
@@ -19,7 +19,7 @@
 import org.apache.commons.validator.routines.CodeValidator;
 
 /**
- * Check Digit calculation and validation.
+ * Check Digit calculation and validation.
  * 
      
  * The logic for validating check digits has previously been
  * embedded within the logic for specific code validation, which
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 e6d56e9b5..8092a8d2f 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
@@ -17,7 +17,7 @@
 package org.apache.commons.validator.routines.checkdigit;
 
 /**
- * Modulus 10 EAN-13 / UPC / ISBN-13 Check Digit
+ * Modulus 10 EAN-13 / UPC / ISBN-13 Check Digit
  * calculation/validation.
  * 
      
  * Check digit calculation is based on modulus 10 with digits in
@@ -59,9 +59,9 @@ public EAN13CheckDigit() {
      * 
      Calculates the weighted value of a character in the
      * code at a specified position.
      
      *
-     * 
      For EAN-13 (from right to left) odd digits are weighted
-     * with a factor of one and even digits with a factor
-     * of three.
      
+     * 
      For EAN-13 (from right to left) odd digits are weighted
+     * with a factor of one and even digits with a factor
+     * of three.
      
      *
      * @param charValue The numeric value of the character.
      * @param leftPos The position of the character in the code, counting from left to right
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 a8212e405..653e7bf51 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
@@ -20,7 +20,7 @@
 import org.apache.commons.validator.routines.CodeValidator;
 
 /**
- * Modulus 11 EC number Check Digit calculation/validation.
+ * Modulus 11 EC number Check Digit calculation/validation.
  *
  * 
      
  * The European Community number (EC number) is a unique seven-digit identifier
diff --git a/src/main/java/org/apache/commons/validator/routines/checkdigit/IBANCheckDigit.java b/src/main/java/org/apache/commons/validator/routines/checkdigit/IBANCheckDigit.java
index eabae4ffe..d4c211903 100644
--- a/src/main/java/org/apache/commons/validator/routines/checkdigit/IBANCheckDigit.java
+++ b/src/main/java/org/apache/commons/validator/routines/checkdigit/IBANCheckDigit.java
@@ -19,7 +19,7 @@
 import java.io.Serializable;
 
 /**
- * IBAN (International Bank Account Number) Check Digit calculation/validation.
+ * IBAN (International Bank Account Number) Check Digit calculation/validation.
  * 
      
  * This routine is based on the ISO 7064 Mod 97,10 check digit calculation routine.
  * 
      
@@ -63,7 +63,7 @@ public IBANCheckDigit() {
     /**
      * Calculate the Check Digit for an IBAN code.
      * 
      
-     * Note: The check digit is the third and fourth
+     * Note: The check digit is the third and fourth
      * characters and is set to the value "{@code 00}".
      *
      * @param code The code to calculate the Check Digit for
diff --git a/src/main/java/org/apache/commons/validator/routines/checkdigit/ISBN10CheckDigit.java b/src/main/java/org/apache/commons/validator/routines/checkdigit/ISBN10CheckDigit.java
index bcd60623a..13cb95fc4 100644
--- a/src/main/java/org/apache/commons/validator/routines/checkdigit/ISBN10CheckDigit.java
+++ b/src/main/java/org/apache/commons/validator/routines/checkdigit/ISBN10CheckDigit.java
@@ -17,7 +17,7 @@
 package org.apache.commons.validator.routines.checkdigit;
 
 /**
- * Modulus 11 ISBN-10 Check Digit calculation/validation.
+ * Modulus 11 ISBN-10 Check Digit calculation/validation.
  * 
      
  * ISBN-10 Numbers are a numeric code except for the last (check) digit
  * which can have a value of "X".
@@ -27,7 +27,7 @@
  * 1, the second 2 and so on. If the check digit is calculated as "10" it is converted
  * to "X".
  * 
      
- * N.B. From 1st January 2007 the book industry will start to use a new 13 digit
+ * N.B. From 1st January 2007 the book industry will start to use a new 13 digit
  * ISBN number (rather than this 10 digit ISBN number) which uses the EAN-13 / UPC
  * (see {@link EAN13CheckDigit}) standard.
  * 
      
diff --git a/src/main/java/org/apache/commons/validator/routines/checkdigit/ISBNCheckDigit.java b/src/main/java/org/apache/commons/validator/routines/checkdigit/ISBNCheckDigit.java
index 352dba4b5..a3d99bdee 100644
--- a/src/main/java/org/apache/commons/validator/routines/checkdigit/ISBNCheckDigit.java
+++ b/src/main/java/org/apache/commons/validator/routines/checkdigit/ISBNCheckDigit.java
@@ -21,7 +21,7 @@
 import org.apache.commons.validator.GenericValidator;
 
 /**
- * Combined ISBN-10 / ISBN-13 Check Digit calculation/validation.
+ * Combined ISBN-10 / ISBN-13 Check Digit calculation/validation.
  * 
      
  * This implementation validates/calculates ISBN check digits
  * based on the length of the code passed to it - delegating
@@ -29,7 +29,7 @@
  * {@link ISBNCheckDigit#ISBN13_CHECK_DIGIT} routines to perform the actual
  * validation/calculation.
  * 
      
- * N.B. From 1st January 2007 the book industry will start to use a new 13 digit
+ * N.B. From 1st January 2007 the book industry will start to use a new 13 digit
  * ISBN number (rather than this 10 digit ISBN number) which uses the EAN-13 / UPC
  * standard.
  *
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 d65aa0566..0d67373c7 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
@@ -17,7 +17,7 @@
 package org.apache.commons.validator.routines.checkdigit;
 
 /**
- * Modulus 10 ISIN (International Securities Identifying Number) Check Digit calculation/validation.
+ * Modulus 10 ISIN (International Securities Identifying Number) Check Digit calculation/validation.
  *
  * 
      
  * ISIN Numbers are 12 character alphanumeric codes used
@@ -90,9 +90,9 @@ protected int calculateModulus(final String code, final boolean includesCheckDig
      * 
      Calculates the weighted value of a character in the
      * code at a specified position.
      
      *
-     * 
      For ISIN (from right to left) odd digits are weighted
-     * with a factor of one and even digits with a factor
-     * of two. Weighted values are reduced to their digital root
      
+     * 
      For ISIN (from right to left) odd digits are weighted
+     * with a factor of one and even digits with a factor
+     * of two. Weighted values are reduced to their digital root
      
      *
      * @param charValue The numeric value of the character.
      * @param leftPos  The position of the character in the code, counting from left to right
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 df58d0262..3d9de5a93 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
@@ -37,7 +37,7 @@
  * ISSN 1050-124X
  *
    *

    - * Note: This class expects the input to be numeric only, + * Note: This class expects the input to be numeric only, * with all formatting removed. * For example: * 

    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 46ea0b22b..cf170de3d 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
@@ -17,7 +17,7 @@
 package org.apache.commons.validator.routines.checkdigit;
 
 /**
- * Modulus 10 Luhn Check Digit calculation/validation.
+ * Modulus 10 Luhn Check Digit calculation/validation.
  *
  * Luhn check digits are used, for example, by:
  * 
      
@@ -56,9 +56,9 @@ public LuhnCheckDigit() {
      * 
      Calculates the weighted value of a character in the
      * code at a specified position.
      
      *
-     * 
      For Luhn (from right to left) odd digits are weighted
-     * with a factor of one and even digits with a factor
-     * of two. Weighted values > 9, have 9 subtracted
      
+     * 
      For Luhn (from right to left) odd digits are weighted
+     * with a factor of one and even digits with a factor
+     * of two. Weighted values > 9, have 9 subtracted
      
      *
      * @param charValue The numeric value of the character.
      * @param leftPos The position of the character in the code, counting from left to right
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 df6371d61..41339cea3 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
@@ -21,12 +21,12 @@
 import org.apache.commons.validator.GenericValidator;
 
 /**
- * Abstract Modulus Check digit calculation/validation.
+ * Abstract Modulus Check digit calculation/validation.
  * 
      
  * Provides a base class for building modulus Check Digit routines.
  * 
      
  * 
      
- * This implementation only handles single-digit numeric codes, such as EAN-13. For alphanumeric codes such as EAN-128 you will need
+ * This implementation only handles single-digit numeric codes, such as EAN-13. For alphanumeric codes such as EAN-128 you will need
  * to implement/override the {@code toInt()} and {@code toChar()} methods.
  * 
      
  *
@@ -149,7 +149,7 @@ public boolean isValid(final String code) {
     /**
      * Convert an integer value to a check digit.
      * 
      
-     * Note: this implementation only handles single-digit numeric values
+     * Note: this implementation only handles single-digit numeric values
      * For non-numeric characters, override this method to provide
      * integer-->character conversion.
      *
@@ -168,7 +168,7 @@ protected String toCheckDigit(final int charValue) throws CheckDigitException {
     /**
      * Convert a character at a specified position to an integer value.
      * 
      
-     * Note: this implementation only handlers numeric values
+     * Note: this implementation only handlers numeric values
      * For non-numeric characters, override this method to provide
      * character-->integer conversion.
      *
diff --git a/src/main/java/org/apache/commons/validator/routines/checkdigit/ModulusTenCheckDigit.java b/src/main/java/org/apache/commons/validator/routines/checkdigit/ModulusTenCheckDigit.java
index 337b70fd6..1632f030c 100644
--- a/src/main/java/org/apache/commons/validator/routines/checkdigit/ModulusTenCheckDigit.java
+++ b/src/main/java/org/apache/commons/validator/routines/checkdigit/ModulusTenCheckDigit.java
@@ -56,7 +56,7 @@
  * 
    • There are no checks on code length.
      • 
  * 
    
  * 
    
- * Note: This implementation can be combined with the
+ * Note: This implementation can be combined with the
  * {@link CodeValidator} in order to ensure the length and characters are valid.
  *
  * 
    Example Usage
    
@@ -65,7 +65,7 @@
  * are shown re-implemented using this routine below:
  *
  * 
    
- * ABA Number Check Digit Routine (equivalent of
+ * ABA Number Check Digit Routine (equivalent of
  * {@link ABANumberCheckDigit}). Weighting factors are {@code [1, 7, 3]}
  * applied from right to left.
  *
@@ -74,7 +74,7 @@
  *
    * *

    - * CUSIP Check Digit Routine (equivalent of {@link CUSIPCheckDigit}). + * CUSIP Check Digit Routine (equivalent of {@link CUSIPCheckDigit}). * Weighting factors are {@code [1, 2]} applied from right to left and the * digits of the weighted value are summed. * @@ -83,7 +83,7 @@ * * *

    - * EAN-13 / UPC Check Digit Routine (equivalent of + * EAN-13 / UPC Check Digit Routine (equivalent of * {@link EAN13CheckDigit}). Weighting factors are {@code [1, 3]} applied * from right to left. * @@ -92,7 +92,7 @@ * * *

    - * Luhn Check Digit Routine (equivalent of {@link LuhnCheckDigit}). + * Luhn Check Digit Routine (equivalent of {@link LuhnCheckDigit}). * Weighting factors are {@code [1, 2]} applied from right to left and the * digits of the weighted value are summed. * @@ -101,7 +101,7 @@ * * *

    - * SEDOL Check Digit Routine (equivalent of {@link SedolCheckDigit}). + * SEDOL Check Digit Routine (equivalent of {@link SedolCheckDigit}). * Weighting factors are {@code [1, 3, 1, 7, 3, 9, 1]} applied from left to * right. * @@ -195,7 +195,7 @@ public boolean isValid(final String code) { /** * Convert a character at a specified position to an integer value. *

    - * Note: this implementation only handlers values that + * Note: this implementation only handlers values that * Character.getNumericValue(char) returns a non-negative number. * * @param character The character to convert diff --git a/src/main/java/org/apache/commons/validator/routines/checkdigit/SedolCheckDigit.java b/src/main/java/org/apache/commons/validator/routines/checkdigit/SedolCheckDigit.java index 32a967402..3ebc69ccc 100644 --- a/src/main/java/org/apache/commons/validator/routines/checkdigit/SedolCheckDigit.java +++ b/src/main/java/org/apache/commons/validator/routines/checkdigit/SedolCheckDigit.java @@ -17,7 +17,7 @@ package org.apache.commons.validator.routines.checkdigit; /** - * Modulus 10 SEDOL (UK Securities) Check Digit calculation/validation. + * Modulus 10 SEDOL (UK Securities) Check Digit calculation/validation. * *

    * SEDOL Numbers are 7 character alphanumeric codes used diff --git a/src/main/java/org/apache/commons/validator/routines/checkdigit/VerhoeffCheckDigit.java b/src/main/java/org/apache/commons/validator/routines/checkdigit/VerhoeffCheckDigit.java index c5d4ebb10..7cc96afbb 100644 --- a/src/main/java/org/apache/commons/validator/routines/checkdigit/VerhoeffCheckDigit.java +++ b/src/main/java/org/apache/commons/validator/routines/checkdigit/VerhoeffCheckDigit.java @@ -21,7 +21,7 @@ import org.apache.commons.validator.GenericValidator; /** - * Verhoeff (Dihedral) Check Digit calculation/validation. + * Verhoeff (Dihedral) Check Digit calculation/validation. *

    * Check digit calculation for numeric codes using a * Dihedral Group diff --git a/src/main/java/org/apache/commons/validator/routines/checkdigit/package-info.java b/src/main/java/org/apache/commons/validator/routines/checkdigit/package-info.java index ef6a12edf..0a9aeaa4b 100644 --- a/src/main/java/org/apache/commons/validator/routines/checkdigit/package-info.java +++ b/src/main/java/org/apache/commons/validator/routines/checkdigit/package-info.java @@ -18,7 +18,7 @@ /** * This package contains Check Digit validation/calculation routines. *

    - * Note that these do not validate the input for length or syntax. Such validation is performed by the org.apache.commons.validator.routines.XYZValidator + * Note that these do not validate the input for length or syntax. Such validation is performed by the org.apache.commons.validator.routines.XYZValidator * classes. *

    */ diff --git a/src/main/java/org/apache/commons/validator/routines/package-info.java b/src/main/java/org/apache/commons/validator/routines/package-info.java index 9fdb8beab..6b6dea470 100644 --- a/src/main/java/org/apache/commons/validator/routines/package-info.java +++ b/src/main/java/org/apache/commons/validator/routines/package-info.java @@ -406,7 +406,7 @@ * by creating a new instance, which caches and re-uses compiled Patterns. *

    *
      - *
    • Method Flavours - three flavors of validation metods are provided:
      • + *
    • Method Flavours - three flavors of validation metods are provided:
      • *
    • *
        *
      • {@code isValid()} methods return true/false to indicate @@ -418,9 +418,9 @@ * of the matched groups or {@code null} if invalid.
        • *
      *
      • - *
    • Case Sensitivity - matching can be done in either a case + *
    • Case Sensitivity - matching can be done in either a case * sensitive or case in-sensitive way.
      • - *
    • Multiple Expressions - instances of the + *
    • Multiple Expressions - instances of the * RegexValidator * can be created to either match against a single regular expression * or set (String array) of regular expressions.
      • @@ -489,26 +489,26 @@ *

      *
        *
      • ABANumberCheckDigit - * for ABA Number (or Routing Transit Number (RTN)) check digit calculation.
        • + * for ABA Number (or Routing Transit Number (RTN)) check digit calculation. *
      • CUSIPCheckDigit - * for CUSIP (North American Securities) check digit calculation.
        • + * for CUSIP (North American Securities) check digit calculation. *
      • EAN13CheckDigit - * for EAN-13, UPC, ISBN-13 check digit calculation.
        • + * for EAN-13, UPC, ISBN-13 check digit calculation. *
      • ISBNCheckDigit - * for ISBN-10 and ISBN-13 check digit calculation.
        • + * for ISBN-10 and ISBN-13 check digit calculation. *
      • ISBN10CheckDigit - * for ISBN-10 check digit calculation.
        • + * for ISBN-10 check digit calculation. *
      • ISINCheckDigit - * for ISIN International Securities Identifying Number check digit calculation.
        • + * for ISIN International Securities Identifying Number check digit calculation. *
      • LuhnCheckDigit - * for Luhn check digit calculation - used by credit cards.
        • + * for Luhn check digit calculation - used by credit cards. *
      • ModulusCheckDigit - * - abstract class for custom modulus check digit + * - abstract class for custom modulus check digit * implementations.
        • *
      • SedolCheckDigit - * for SEDOL (UK Securities) check digit calculation.
        • + * for SEDOL (UK Securities) check digit calculation. *
      • VerhoeffCheckDigit - * for Verhoeff (Dihedral) check digit calculation.
        • + * for Verhoeff (Dihedral) check digit calculation. *
      *

      * The following examples show validating the check digit of a code: @@ -550,13 +550,13 @@ * validations on a code: *

      *
        - *
      • Format - the format of the code is validated using + *
      • Format - the format of the code is validated using * a regular expression (see RegexValidator).
        • - *
      • Length - the minimum/maximum length of the code is + *
      • Length - the minimum/maximum length of the code is * checked - after being parsed by the regular expression - with which * format characters can be removed with the use of * non-capturing groups.
        • - *
      • Check Digit - a CheckDigit + *
      • Check Digit - a CheckDigit * routine checks that code's check digit is valid.
        • *
      *

      @@ -579,7 +579,7 @@ * ISBN-10 codes to ISBN-13. *

      *
        - *
      • ISBN-10 - validates using a + *
      • ISBN-10 - validates using a * CodeValidator with the * ISBN10CheckDigit * routine.
        • @@ -589,7 +589,7 @@ *
      • {@code validateISBN10(value)} - returns a reformatted ISBN-10 code
        • *
      * - *
    • ISBN-13 - validates using a + *
    • ISBN-13 - validates using a * CodeValidator with the * EAN13CheckDigit * routine.
      • @@ -599,7 +599,7 @@ *
    • {@code validateISBN13(value)} - returns a reformatted ISBN-13 code
      • *
    * - *
  • ISBN-10 and ISBN-13 - validates codes are either + *
  • ISBN-10 and ISBN-13 - validates codes are either * valid ISBN-10 or valid ISBN-13 - optionally can convert ISBN-10 codes to ISBN-13.
    • *
  • *
      diff --git a/src/test/java/org/apache/commons/validator/EmailTest.java b/src/test/java/org/apache/commons/validator/EmailTest.java index b61a3062d..f584f68fb 100644 --- a/src/test/java/org/apache/commons/validator/EmailTest.java +++ b/src/test/java/org/apache/commons/validator/EmailTest.java @@ -186,7 +186,7 @@ public void testEmailLocalhost() throws ValidatorException { * Write this test according to parts of RFC, as opposed to the type of character that is being tested. * *

      - * FIXME: This test fails so disable it with a leading _ for 1.1.4 release. The real solution is to fix the email parsing. + * FIXME: This test fails so disable it with a leading _ for 1.1.4 release. The real solution is to fix the email parsing. * * @throws ValidatorException */