svn commit: r1715297 - in /commons/proper/validator/trunk/src/main/java/org/apache/commons/validator/routines: IBANValidator.java checkdigit/ISSNCheckDigit.java

[se...@apache.org]

Author: sebb
Date: Thu Nov 19 22:15:35 2015
New Revision: 1715297

URL: http://svn.apache.org/viewvc?rev=1715297&view=rev
Log:
Javadoc

Modified:
    commons/proper/validator/trunk/src/main/java/org/apache/commons/validator/routines/IBANValidator.java
    commons/proper/validator/trunk/src/main/java/org/apache/commons/validator/routines/checkdigit/ISSNCheckDigit.java

Modified: commons/proper/validator/trunk/src/main/java/org/apache/commons/validator/routines/IBANValidator.java
URL: http://svn.apache.org/viewvc/commons/proper/validator/trunk/src/main/java/org/apache/commons/validator/routines/IBANValidator.java?rev=1715297&r1=1715296&r2=1715297&view=diff
==============================================================================
--- commons/proper/validator/trunk/src/main/java/org/apache/commons/validator/routines/IBANValidator.java (original)
+++ commons/proper/validator/trunk/src/main/java/org/apache/commons/validator/routines/IBANValidator.java Thu Nov 19 22:15:35 2015
@@ -31,6 +31,9 @@ public class IBANValidator {
 
     private final Map<String, Validator> formatValidators;
 
+    /**
+     * The validation class
+     */
     public static class Validator {
         /*
          * The minimum length does not appear to be defined by the standard.
@@ -46,6 +49,13 @@ public class IBANValidator {
         final String countryCode;
         final RegexValidator validator;
         final int lengthOfIBAN; // used to avoid unnecessary regex matching
+
+        /**
+         * Creates the validator
+         * @param cc the country code
+         * @param len the length of the IBAN
+         * @param format the regex to use to check the format
+         */
         public Validator(String cc, int len, String format) {
             if (!(cc.length() == 2 && Character.isUpperCase(cc.charAt(0)) && Character.isUpperCase(cc.charAt(1)))) {
                 throw new IllegalArgumentException("Invalid country Code; must be exactly 2 upper-case characters");
@@ -156,6 +166,7 @@ public class IBANValidator {
             new Validator("VG", 24, "VG\\d{2}[A-Z]{4}\\d{16}"               ), // Virgin Islands, British
     };
 
+    /** The singleton instance which uses the default formats */
     public static final IBANValidator DEFAULT_IBAN_VALIDATOR = new IBANValidator();
 
     /**

Modified: commons/proper/validator/trunk/src/main/java/org/apache/commons/validator/routines/checkdigit/ISSNCheckDigit.java
URL: http://svn.apache.org/viewvc/commons/proper/validator/trunk/src/main/java/org/apache/commons/validator/routines/checkdigit/ISSNCheckDigit.java?rev=1715297&r1=1715296&r2=1715297&view=diff
==============================================================================
--- commons/proper/validator/trunk/src/main/java/org/apache/commons/validator/routines/checkdigit/ISSNCheckDigit.java (original)
+++ commons/proper/validator/trunk/src/main/java/org/apache/commons/validator/routines/checkdigit/ISSNCheckDigit.java Thu Nov 19 22:15:35 2015
@@ -54,6 +54,9 @@ public final class ISSNCheckDigit extend
     /** Singleton ISSN Check Digit instance */
     public static final CheckDigit ISSN_CHECK_DIGIT = new ISSNCheckDigit();
 
+    /**
+     * Creates the instance using a checkdigit modulus of 11
+     */
     public ISSNCheckDigit() {
         super(11);
     }