Package org.apache.commons.validator.routines.checkdigit

Class IBANCheckDigit

java.lang.Object
org.apache.commons.validator.routines.checkdigit.ModulusCheckDigit
org.apache.commons.validator.routines.checkdigit.IsoIec7064PureSystem
org.apache.commons.validator.routines.checkdigit.Modulus97CheckDigit
org.apache.commons.validator.routines.checkdigit.IBANCheckDigit
All Implemented Interfaces:
Serializable, CheckDigit, IsoIecConstants
public final class IBANCheckDigit extends Modulus97CheckDigit
IBAN (International Bank Account Number) Check Digit calculation/validation.

This routine is based on the ISO 7064 Mod 97,10 check digit calculation routine.

The two check digit characters in a IBAN number are the third and fourth characters in the code. For check digit calculation/validation the first four characters are moved to the end of the code. So CCDDnnnnnnn becomes nnnnnnnCCDD (where CC is the country code and DD is the check digit). For check digit calculation the check digit value should be set to zero (i.e. CC00nnnnnnn in this example.

Note: the class does not check the format of the IBAN number, only the check digits.

For further information see Wikipedia - IBAN number.

Since:
1.4
See Also:

  • Constructor Details

    • IBANCheckDigit

      public IBANCheckDigit()

  • Method Details

    • getInstance

      public static CheckDigit getInstance()
      Gets the singleton instance of this validator.
      Returns:
      A singleton instance of the class.

    • calculate

      public String calculate(String code) throws CheckDigitException
      Calculate the Check Digit for an IBAN code.

      Note: The check digit is the third and fourth characters and is set to the value "00".

      Specified by:
      calculate in interface CheckDigit
      Overrides:
      calculate in class Modulus97CheckDigit
      Parameters:
      code - The code to calculate the Check Digit for
      Returns:
      The calculated Check Digit as 2 numeric decimal characters, e.g. "42"
      Throws:
      CheckDigitException - if an error occurs calculating the check digit for the specified code

    • isValid

      public boolean isValid(String code)
      Validate the check digit of an IBAN code.
      Specified by:
      isValid in interface CheckDigit
      Overrides:
      isValid in class Modulus97CheckDigit
      Parameters:
      code - The code to validate
      Returns:
      true if the check digit is valid, otherwise false