InternationalBankAccountNumber (josef 3.2.5 API)

java.lang.Object
- org.josef.finance.InternationalBankAccountNumber

All Implemented Interfaces:: Serializable

@Status(stage=DEVELOPMENT,
        unitTests=COMPLETE)
 @Review(by="Kees Schotanus",
        at="2009-09-28")
 @ThreadSafety(level=IMMUTABLE)
public class InternationalBankAccountNumber
extends Object
implements Serializable

Abstraction of an IBAN (International Bank Account Number).
For further information about IBAN see: ECBS.

Version:: 1.0 $Revision: 6488 $
Author:: Ahmed Saghir, Kees Schotanus
See Also:: Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`MSG_BBAN_FORMAT_IS_INCORRECT` Key to lookup: The BBAN's format is incorrect.
`static String`	`MSG_BBAN_IS_MANDATORY` Key to lookup: The BBAN is mandatory.
`static String`	`MSG_BBAN_IS_TOO_LONG` Key to lookup: The length of the BBAN is too long.
`static String`	`MSG_COUNTRY_DOES_NOT_EXIST` Key to lookup: The country does not exist.
`static String`	`MSG_COUNTRY_FORMAT_IS_INCORRECT` Key to lookup: The country's format (2 capital letters) is incorrect.
`static String`	`MSG_COUNTRY_IS_MANDATORY` Key to lookup: The country is mandatory.
`static String`	`MSG_COUNTRY_LENGTH_IS_INCORRECT` Key to lookup: The country's length is incorrect.
`static String`	`MSG_IBAN_CHECK_DIGITS_ARE_ILLEGAL` Key to lookup: IBAN has illegal check digits.
`static String`	`MSG_IBAN_CHECK_DIGITS_ARE_NOT_NUMERIC` Key to lookup: IBAN has non-numeric check digits.
`static String`	`MSG_IBAN_COUNTRY_DOES_NOT_EXIST` Key to lookup: IBAN has incorrect country.
`static String`	`MSG_IBAN_HAS_LOWER_CASE` Key to lookup: IBAN contains lower case letters.
`static String`	`MSG_IBAN_IS_NOT_ALPHA_NUMERIC` Key to lookup: IBAN contains non alpha numeric characters.
`static String`	`MSG_IBAN_IS_NULL_OR_EMPTY` Key to lookup: IBAN is null or empty.
`static String`	`MSG_IBAN_IS_TOO_LONG` Key to lookup: IBAN is too long.
`static String`	`MSG_IBAN_IS_TOO_SHORT` Key to lookup: IBAN is too short.
`static String`	`MSG_IBAN_NOT_MODULO_97` Key to lookup: IBAN does not pass modulo 97 check.

Constructor Summary

Constructors
Constructor and Description
`InternationalBankAccountNumber(String iban)` Constructs an IBAN object from the supplied iban String.
`InternationalBankAccountNumber(String country, String bban)` Constructs an IBAN object from the supplied country and bban (Basic Bank Account Number).

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`checkBasicBankAccountNumber(String bban)` Checks that the supplied bban (Basic Bank Account Number) is valid.
`static void`	`checkCountry(String country)` Checks that the supplied country is valid.
`static void`	`checkIban(String iban)` Checks whether the supplied iban is valid.
`String`	`getBasicBankAccountNumber()` Gets the Basic Bank Account Number (BBAN) from this IBAN.
`String`	`getCheckDigits()` Gets the check digits from this IBAN.
`String`	`getCountry()` Gets the country from this IBAN.
`static boolean`	`isValidIban(String iban)` Checks whether the supplied iban is valid.
`static void`	`main(String[] args)` Simple test method.
`String`	`toPaperFormat()` Creates the paper format of this IBAN.
`String`	`toString()` Creates a String representation of this IBAN consisting of the IBAN itself.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - MSG_BBAN_IS_MANDATORY
```
public static final String MSG_BBAN_IS_MANDATORY
```
    Key to lookup: The BBAN is mandatory.
    Arguments:
    - BBAN
    .
    See Also:
    
    Constant Field Values
  - MSG_BBAN_IS_TOO_LONG
```
public static final String MSG_BBAN_IS_TOO_LONG
```
    Key to lookup: The length of the BBAN is too long.
    Arguments:
    - BBAN
    .
    See Also:
    
    Constant Field Values
  - MSG_BBAN_FORMAT_IS_INCORRECT
```
public static final String MSG_BBAN_FORMAT_IS_INCORRECT
```
    Key to lookup: The BBAN's format is incorrect. Should contain alpha numeric characters only.
    Arguments:
    - BBAN
    .
    See Also:
    
    Constant Field Values
  - MSG_COUNTRY_IS_MANDATORY
```
public static final String MSG_COUNTRY_IS_MANDATORY
```
    Key to lookup: The country is mandatory.
    Arguments:
    - Country
    .
    See Also:
    
    Constant Field Values
  - MSG_COUNTRY_LENGTH_IS_INCORRECT
```
public static final String MSG_COUNTRY_LENGTH_IS_INCORRECT
```
    Key to lookup: The country's length is incorrect.
    Arguments:
    - Country
    .
    See Also:
    
    Constant Field Values
  - MSG_COUNTRY_FORMAT_IS_INCORRECT
```
public static final String MSG_COUNTRY_FORMAT_IS_INCORRECT
```
    Key to lookup: The country's format (2 capital letters) is incorrect.
    Arguments:
    - Country
    .
    See Also:
    
    Constant Field Values
  - MSG_COUNTRY_DOES_NOT_EXIST
```
public static final String MSG_COUNTRY_DOES_NOT_EXIST
```
    Key to lookup: The country does not exist.
    Arguments:
    - Country
    .
    See Also:
    
    Constant Field Values
  - MSG_IBAN_IS_NULL_OR_EMPTY
```
public static final String MSG_IBAN_IS_NULL_OR_EMPTY
```
    Key to lookup: IBAN is null or empty.
    Arguments: None.
    
    See Also:
    
    Constant Field Values
  - MSG_IBAN_IS_TOO_SHORT
```
public static final String MSG_IBAN_IS_TOO_SHORT
```
    Key to lookup: IBAN is too short.
    Arguments:
    - IBAN
    .
    See Also:
    
    Constant Field Values
  - MSG_IBAN_IS_TOO_LONG
```
public static final String MSG_IBAN_IS_TOO_LONG
```
    Key to lookup: IBAN is too long.
    Arguments:
    - IBAN
    .
    See Also:
    
    Constant Field Values
  - MSG_IBAN_HAS_LOWER_CASE
```
public static final String MSG_IBAN_HAS_LOWER_CASE
```
    Key to lookup: IBAN contains lower case letters.
    Arguments:
    - IBAN
    .
    See Also:
    
    Constant Field Values
  - MSG_IBAN_IS_NOT_ALPHA_NUMERIC
```
public static final String MSG_IBAN_IS_NOT_ALPHA_NUMERIC
```
    Key to lookup: IBAN contains non alpha numeric characters.
    Arguments:
    - IBAN
    .
    See Also:
    
    Constant Field Values
  - MSG_IBAN_COUNTRY_DOES_NOT_EXIST
```
public static final String MSG_IBAN_COUNTRY_DOES_NOT_EXIST
```
    Key to lookup: IBAN has incorrect country.
    Arguments:
    - IBAN
    - Country
    .
    See Also:
    
    Constant Field Values
  - MSG_IBAN_CHECK_DIGITS_ARE_NOT_NUMERIC
```
public static final String MSG_IBAN_CHECK_DIGITS_ARE_NOT_NUMERIC
```
    Key to lookup: IBAN has non-numeric check digits.
    Arguments:
    - IBAN
    - Check digits
    .
    See Also:
    
    Constant Field Values
  - MSG_IBAN_CHECK_DIGITS_ARE_ILLEGAL
```
public static final String MSG_IBAN_CHECK_DIGITS_ARE_ILLEGAL
```
    Key to lookup: IBAN has illegal check digits.
    Due to Modula-97 check the check digits can't ever be 00, 01 or 99.
    Arguments:
    - IBAN
    - Check digits
    .
    See Also:
    
    Constant Field Values
  - MSG_IBAN_NOT_MODULO_97
```
public static final String MSG_IBAN_NOT_MODULO_97
```
    Key to lookup: IBAN does not pass modulo 97 check.
    Arguments:
    - IBAN
    .
    See Also:
    
    Constant Field Values
- Constructor Detail
  - InternationalBankAccountNumber
```
public InternationalBankAccountNumber(String iban)
                               throws InvalidArgumentException
```
    Constructs an IBAN object from the supplied iban String.
    
    Parameters:
    
    iban - An International Bank Account Number.
    The iban should be in "electronic form", that is, it should not contain any separators.
    
    Throws:
    
    InvalidArgumentException - When the supplied iban does not contain a valid IBAN.
    See: checkIban(String) for the definition of a valid IBAN.
  - InternationalBankAccountNumber
```
public InternationalBankAccountNumber(String country,
                                      String bban)
                               throws InvalidArgumentException
```
    Constructs an IBAN object from the supplied country and bban (Basic Bank Account Number).
    This constructor automatically computes the check digits.
    
    Parameters:
    
    country - Two letter ISO-3166 country code.
    
    bban - Basic Bank Account Number.
    
    Throws:
    
    InvalidArgumentException - When the supplied country or the supplied bban are not valid or when the combination does not form a valid IBAN.
    See: checkIban(String) for the definition of a valid IBAN.
- Method Detail
  - getCountry
```
public String getCountry()
```
    Gets the country from this IBAN.
    A country is a 2 letter code (ISO-3166).
    
    Returns:
    
    The country.
  - getCheckDigits
```
public String getCheckDigits()
```
    Gets the check digits from this IBAN.
    The check digits consist of a String containing 2 digits.
    
    Returns:
    
    The check digits.
  - getBasicBankAccountNumber
```
public String getBasicBankAccountNumber()
```
    Gets the Basic Bank Account Number (BBAN) from this IBAN.
    The BBAN's format is different from country to country. The length of the BBAN per country however is fixed. In the Netherlands for example the BBAN consists of 4 letters for the bank and 9 digits (zero filled) for the bank account.
    
    Returns:
    
    The Basic Bank Account Number.
  - isValidIban
```
public static boolean isValidIban(String iban)
```
    Checks whether the supplied iban is valid. For details see: checkIban(String) .
    
    Parameters:
    
    iban - The iban to check.
    
    Returns:
    
    True when the supplied iban is valid, otherwise false.
  - checkIban
```
public static void checkIban(String iban)
                      throws InvalidArgumentException
```
    Checks whether the supplied iban is valid.
    AN iban (International Bank Account Number) consists of:
    ISO-3166 2 letter (upper case) country code
    2 numeric check digits
    Up to 30 alphanumeric bban (Basic Bank Account Number) which has a fixed length that differs per country
    Currently all possible validations but the check on ban length are being performed on the supplied iban.
    
    Parameters:
    
    iban - The iban to check.
    
    Throws:
    
    InvalidArgumentException - When the supplied iban is not valid.
  - checkCountry
```
public static void checkCountry(String country)
                         throws InvalidArgumentException
```
    Checks that the supplied country is valid.
    A country is valid when it is a valid ISO-3166 country code. This code consists of 2 upper-case letters.
    
    Parameters:
    
    country - The country to check.
    
    Throws:
    
    InvalidArgumentException - When the supplied country is not a valid ISO-3166 country code.
  - checkBasicBankAccountNumber
```
public static void checkBasicBankAccountNumber(String bban)
                                        throws InvalidArgumentException
```
    Checks that the supplied bban (Basic Bank Account Number) is valid.
    A bban is valid when the following conditions are met:
    - non null
    - alpha-numeric
    - Not longer than 30 characters
    Parameters:
    
    bban - The Basic Bank Account Number to check.
    
    Throws:
    
    InvalidArgumentException - When the supplied bban is not valid.
  - toPaperFormat
```
public String toPaperFormat()
```
    Creates the paper format of this IBAN.
    The paper format is created by adding a space to every fourth character of the electronic form.
    
    Returns:
    
    Paper format of this IBAN.
  - toString
```
public String toString()
```
    Creates a String representation of this IBAN consisting of the IBAN itself.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    The IBAN.
  - main
```
public static void main(String[] args)
                 throws InvalidArgumentException
```
    Simple test method.
    
    Parameters:
    
    args - Not used.
    
    Throws:
    
    InvalidArgumentException - When one of the iban's is not valid.

Class InternationalBankAccountNumber

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MSG_BBAN_IS_MANDATORY

MSG_BBAN_IS_TOO_LONG

MSG_BBAN_FORMAT_IS_INCORRECT

MSG_COUNTRY_IS_MANDATORY

MSG_COUNTRY_LENGTH_IS_INCORRECT

MSG_COUNTRY_FORMAT_IS_INCORRECT

MSG_COUNTRY_DOES_NOT_EXIST

MSG_IBAN_IS_NULL_OR_EMPTY

MSG_IBAN_IS_TOO_SHORT

MSG_IBAN_IS_TOO_LONG

MSG_IBAN_HAS_LOWER_CASE

MSG_IBAN_IS_NOT_ALPHA_NUMERIC

MSG_IBAN_COUNTRY_DOES_NOT_EXIST

MSG_IBAN_CHECK_DIGITS_ARE_NOT_NUMERIC

MSG_IBAN_CHECK_DIGITS_ARE_ILLEGAL

MSG_IBAN_NOT_MODULO_97

Constructor Detail

InternationalBankAccountNumber

InternationalBankAccountNumber

Method Detail

getCountry

getCheckDigits

getBasicBankAccountNumber

isValidIban

checkIban

checkCountry

checkBasicBankAccountNumber

toPaperFormat

toString

main