Class IBANValidator

java.lang.Object
org.apache.commons.validator.routines.IBANValidator
public class IBANValidator extends Object
IBAN Validator.

Checks an IBAN for:

  • country code prefix
  • IBAN length
  • pattern (digits and/or uppercase letters)
  • IBAN Checkdigits (using IBANCheckDigit)
The class does not perform checks on the embedded BBAN (Basic Bank Account Number). Each country has its own rules for these.

The validator includes a default set of formats derived from the IBAN registry at https://www.swift.com/standards/data-standards/iban.

This can get out of date, but the set can be adjusted by creating a validator and using the setValidator(String, int, String) or setValidator(Validator) method to add (or remove) an entry.

For example: 

IBANValidator ibv = new IBANValidator();
ibv.setValidator("XX", 12, "XX\\d{10}")

The singleton default instance cannot be modified in this way.

Since:
1.5.0

  • Field Details

  • Constructor Details

    • IBANValidator

      public IBANValidator()
      Create a default IBAN validator.

    • IBANValidator

      public IBANValidator(IBANValidator.Validator[] validators)
      Create an IBAN validator from the specified map of IBAN formats.
      Parameters:
      validators - map of IBAN formats.

  • Method Details

    • getInstance

      public static IBANValidator getInstance()
      Gets the singleton instance of the IBAN validator using the default formats.
      Returns:
      A singleton instance of the IBAN validator.

    • getDefaultValidators

      public IBANValidator.Validator[] getDefaultValidators()
      Gets a copy of the default Validators.
      Returns:
      A copy of the default Validator array.

    • getValidator

      public IBANValidator.Validator getValidator(String code)
      Gets the Validator for a given IBAN.
      Parameters:
      code - A string starting with the ISO country code (for example, an IBAN).
      Returns:
      The validator or null if there is not one registered.

    • hasValidator

      public boolean hasValidator(String code)
      Tests if the given code has a validator.
      Parameters:
      code - The code to check.
      Returns:
      true if there is a validator.

    • isValid

      public boolean isValid(String code)
      Tests an IBAN Code.
      Parameters:
      code - The value validation is being performed on.
      Returns:
      true if the value is valid.

    • setValidator

      public IBANValidator.Validator setValidator(String countryCode, int length, String format)
      Installs a validator. Will replace any existing entry which has the same countryCode.
      Parameters:
      countryCode - The country code.
      length - The length of the IBAN. Must be ≥ 8 and ≤ 32. If the length is < 0, the validator is removed, and the format is not used.
      format - The format of the IBAN (as a regular expression).
      Returns:
      The previous Validator, or null if there was none.
      Throws:
      IllegalArgumentException - if there is a problem.
      IllegalStateException - if an attempt is made to modify the singleton validator.

    • setValidator

      public IBANValidator.Validator setValidator(IBANValidator.Validator validator)
      Installs a validator. Will replace any existing entry which has the same countryCode.
      Parameters:
      validator - The instance to install.
      Returns:
      The previous Validator, or null if there was none.
      Throws:
      IllegalStateException - if an attempt is made to modify the singleton validator.

    • validate

      public IBANValidatorStatus validate(String code)
      Validate an IBAN Code.
      Parameters:
      code - The value validation is being performed on.
      Returns:
      IBANValidatorStatus for validation.
      Since:
      1.10.0