BankIdentifierCode (josef 3.2.5 API)

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

All Implemented Interfaces:

Serializable
```
@Status(stage=DEVELOPMENT,
        unitTests=COMPLETE)
 @Review(by="Kees Schotanus",
        at="2011-03-31")
 @ThreadSafety(level=IMMUTABLE)
public class BankIdentifierCode
extends Object
implements Serializable
```
Abstraction of a Bank Identifier Code (BIC).
BIC was previously known as SWIFT ID or SWIFT code. For further information about BIC see: here or here.
Note: This class neither accepts unconnected BICs nor training BICs.

Version:

1.0 $Revision: 6488 $

Author:

Kees Schotanus

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`MSG_BIC_BANK_CODE_IS_NOT_ALPHABETIC` Key to lookup: BIC contains non alphabetic bank code.
`static String`	`MSG_BIC_COUNTRY_DOES_NOT_EXIST` Key to lookup: BIC has incorrect country.
`static String`	`MSG_BIC_HAS_INCORRECT_LENGTH` Key to lookup: BIC has incorrect length.
`static String`	`MSG_BIC_HAS_LOWER_CASE` Key to lookup: BIC contains lower case letters.
`static String`	`MSG_BIC_IS_NOT_ALPHA_NUMERIC` Key to lookup: BIC contains non alpha numeric characters.
`static String`	`MSG_BIC_IS_NULL_OR_EMPTY` Key to lookup: BIC is null or empty.
`static String`	`MSG_BIC_IS_TEST_BIC` Key to lookup: BIC is a test BIC.
`static String`	`MSG_BIC_IS_UNCONNECTED_BIC` Key to lookup: BIC is an unconnected BIC.

Constructor Summary

Constructors
Constructor and Description

BankIdentifierCode(String bankIdentifierCode)
Constructs this BankIdentifierCode from the supplied bankIdentifierCode.

Constructors
Constructor and Description
`BankIdentifierCode(String bankIdentifierCode)` Constructs this BankIdentifierCode from the supplied bankIdentifierCode.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`checkBankIdentifierCode(String bankIdentifierCode)` Checks whether the supplied bankIdentifierCode is valid.
`String`	`getBankCode()` Gets the bank code from this Bank Identifier Code.
`String`	`getBranchCode()` Gets the optional branch code.
`String`	`getCountryCode()` Gets the country code from this Bank Identifier Code.
`String`	`getLocationCode()` Gets the location code from this Bank Identifier Code.
`static boolean`	`isValidBankIdentifierCode(String bankIdentifierCode)` Checks whether the supplied bankIdentifierCode is valid.
`String`	`toString()` Creates a String representation of this BIC, consisting of the BIC itself.

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

- Field Detail
  - MSG_BIC_IS_NULL_OR_EMPTY
```
public static final String MSG_BIC_IS_NULL_OR_EMPTY
```
    Key to lookup: BIC is null or empty.
    Arguments: None.
    
    See Also:
    
    Constant Field Values
  - MSG_BIC_HAS_INCORRECT_LENGTH
```
public static final String MSG_BIC_HAS_INCORRECT_LENGTH
```
    Key to lookup: BIC has incorrect length.
    Arguments:
    - BIC
    .
    See Also:
    
    Constant Field Values
  - MSG_BIC_HAS_LOWER_CASE
```
public static final String MSG_BIC_HAS_LOWER_CASE
```
    Key to lookup: BIC contains lower case letters.
    Arguments:
    - BIC
    .
    See Also:
    
    Constant Field Values
  - MSG_BIC_IS_NOT_ALPHA_NUMERIC
```
public static final String MSG_BIC_IS_NOT_ALPHA_NUMERIC
```
    Key to lookup: BIC contains non alpha numeric characters.
    Arguments:
    - BIC
    .
    See Also:
    
    Constant Field Values
  - MSG_BIC_BANK_CODE_IS_NOT_ALPHABETIC
```
public static final String MSG_BIC_BANK_CODE_IS_NOT_ALPHABETIC
```
    Key to lookup: BIC contains non alphabetic bank code.
    Arguments:
    - BIC
    - Bank code
    .
    See Also:
    
    Constant Field Values
  - MSG_BIC_COUNTRY_DOES_NOT_EXIST
```
public static final String MSG_BIC_COUNTRY_DOES_NOT_EXIST
```
    Key to lookup: BIC has incorrect country.
    Arguments:
    - BIC
    - Country code
    .
    See Also:
    
    Constant Field Values
  - MSG_BIC_IS_TEST_BIC
```
public static final String MSG_BIC_IS_TEST_BIC
```
    Key to lookup: BIC is a test BIC.
    Arguments:
    - BIC
    .
    See Also:
    
    Constant Field Values
  - MSG_BIC_IS_UNCONNECTED_BIC
```
public static final String MSG_BIC_IS_UNCONNECTED_BIC
```
    Key to lookup: BIC is an unconnected BIC.
    Arguments:
    - BIC
    .
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BankIdentifierCode
```
public BankIdentifierCode(String bankIdentifierCode)
                   throws InvalidArgumentException
```
    Constructs this BankIdentifierCode from the supplied bankIdentifierCode.
    
    Parameters:
    
    bankIdentifierCode - The Bank Identifier Code (BIC).
    
    Throws:
    
    InvalidArgumentException - When the supplied bandIdentifierCode is not valid.
    See: checkBankIdentifierCode(String) for the definition of a valid BIC.
- Method Detail
  - isValidBankIdentifierCode
```
public static boolean isValidBankIdentifierCode(String bankIdentifierCode)
```
    Checks whether the supplied bankIdentifierCode is valid. For details see: checkBankIdentifierCode(String) .
    
    Parameters:
    
    bankIdentifierCode - The Bank Identifier Code to check.
    
    Returns:
    
    True when the supplied bankIdentifierCode is valid, otherwise false.
  - checkBankIdentifierCode
```
public static void checkBankIdentifierCode(String bankIdentifierCode)
                                    throws InvalidArgumentException
```
    Checks whether the supplied bankIdentifierCode is valid.
    A Bank Account Number is valid when it consists of:
    1. A bank code of 4 upper case letters
    2. An ISO-3166 country code of 2 upper case letters
    3. A location code of 2 alphanumeric upper case characters
    Optionally a 3 letter/digit branch code may be added. The absence of this code, or the presence of 'XXX' denotes the primary office.
    Parameters:
    
    bankIdentifierCode - The Bank Identifier Code to check.
    
    Throws:
    
    InvalidArgumentException - When the supplied bankIdentifierCode is not valid.
  - getBankCode
```
public String getBankCode()
```
    Gets the bank code from this Bank Identifier Code.
    
    Returns:
    
    The bank code.
  - getCountryCode
```
public String getCountryCode()
```
    Gets the country code from this Bank Identifier Code.
    A country is a 2 letter code (ISO-3166).
    
    Returns:
    
    The country.
  - getLocationCode
```
public String getLocationCode()
```
    Gets the location code from this Bank Identifier Code.
    A location code is a 2 letter numeric code.
    
    Returns:
    
    The location code.
  - getBranchCode
```
public String getBranchCode()
```
    Gets the optional branch code.
    
    Returns:
    
    The branch code or an empty String when no branch code is present.
  - toString
```
public String toString()
```
    Creates a String representation of this BIC, consisting of the BIC itself.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    The Bank Identifier Code (BIC).

Class BankIdentifierCode

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MSG_BIC_IS_NULL_OR_EMPTY

MSG_BIC_HAS_INCORRECT_LENGTH

MSG_BIC_HAS_LOWER_CASE

MSG_BIC_IS_NOT_ALPHA_NUMERIC

MSG_BIC_BANK_CODE_IS_NOT_ALPHABETIC

MSG_BIC_COUNTRY_DOES_NOT_EXIST

MSG_BIC_IS_TEST_BIC

MSG_BIC_IS_UNCONNECTED_BIC

Constructor Detail

BankIdentifierCode

Method Detail

isValidBankIdentifierCode

checkBankIdentifierCode

getBankCode

getCountryCode

getLocationCode

getBranchCode

toString