Class IBANCheckDigit
java.lang.Object
org.apache.commons.validator.routines.checkdigit.IBANCheckDigit
- All Implemented Interfaces:
Serializable,CheckDigit
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 (such as
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:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final CheckDigitSingleton IBAN Number Check Digit instance -
Constructor Summary
Constructors -
Method Summary
-
Field Details
-
IBAN_CHECK_DIGIT
Singleton IBAN Number Check Digit instance
-
-
Constructor Details
-
IBANCheckDigit
public IBANCheckDigit()Constructs Check Digit routine for IBAN Numbers.
-
-
Method Details
-
calculate
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:
calculatein interfaceCheckDigit- Parameters:
code- The code to calculate the Check Digit for- Returns:
- The calculated Check Digit as 2 numeric decimal characters, for example, "42"
- Throws:
CheckDigitException- if an error occurs calculating the check digit for the specified code
-
isValid
Validate the check digit of an IBAN code.- Specified by:
isValidin interfaceCheckDigit- Parameters:
code- The code to validate- Returns:
trueif the check digit is valid, otherwisefalse
-