BIC (Prowide Core API Reference)

java.lang.Object
- com.prowidesoftware.swift.model.BIC

Direct Known Subclasses:

LogicalTerminalAddress
```
public class BIC
extends java.lang.Object
```
Helper class to process BIC related information.

Since:

3.3

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`branch`
`static java.lang.String`	`PARTNER_PREFIX` Constant value with which all partner bics start
`static java.lang.String`	`TEST12` Fake Logical terminal address for testing, consisting of a fake "test & training" BIC of 12 chars (including the terminal identification)
`static java.lang.String`	`TEST8` Fake "test & training" BIC of 8 chars for testing

Constructor Summary

Constructors
Constructor and Description

BIC()
Default constructor

BIC(java.lang.String bic)
Constructor with BIC code.

Constructors
Constructor and Description
`BIC()` Default constructor
`BIC(java.lang.String bic)` Constructor with BIC code.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`java.lang.String`	`country()` Gets the 2 chars country code of the BIC, which are the 5th and 6th characters
`java.lang.String`	`distinguishedName()` Returns the Distinguished Name (DN) for this BIC.
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getBic()` Deprecated. use getBic8 or getBic11 instead
`java.lang.String`	`getBic11()` Returns the BIC code with 11 characters composed by the first 8 characters of the BIC code, plus the branch code, dropping the logical terminal identifier at position 9 if present, and also padding with a default XXX branch if necessary.
`java.lang.String`	`getBic8()` Returns the first 8 characters of the BIC code.
`java.lang.String`	`getBranch()` It returns the last three that conform the branch or null if branch is not present.
`java.lang.String`	`getInvalidCause()` Get a human readable (english) string that gives information about why the BIC was found invalid.
`java.lang.String`	`getSubtype()`
`int`	`hashCode()`
`java.lang.String`	`institution()` Gets the first 4 characters of the BIC; corresponding to the institution code
`boolean`	`isLive()` Returns true if the BIC is live (connected and not test & training) on the network.
`boolean`	`isNonLive()` Returns true if the BIC is not live (not connected) on the network.
`boolean`	`isTestAndTraining()` Returns true if the BIC is a Test & Training BIC code.
`boolean`	`isValid()` Validates a BIC structure.
`protected void`	`parse(java.lang.String bic)` Parse the given string into the corresponding object attributes.
`void`	`setBic(java.lang.String bic)` Deprecated. use the constructor passing the string as parameter
`void`	`setSubtype(java.lang.String subtype)`
`java.lang.String`	`toString()`

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

- Field Detail
  - TEST8
```
public static final transient java.lang.String TEST8
```
    Fake "test & training" BIC of 8 chars for testing
    
    Since:
    
    7.6
    
    See Also:
    
    Constant Field Values
  - TEST12
```
public static final transient java.lang.String TEST12
```
    Fake Logical terminal address for testing, consisting of a fake "test & training" BIC of 12 chars (including the terminal identification)
    
    Since:
    
    7.6
    
    See Also:
    
    SwiftBlock1.getLogicalTerminal(), Constant Field Values
  - PARTNER_PREFIX
```
public static final java.lang.String PARTNER_PREFIX
```
    Constant value with which all partner bics start
    
    Since:
    
    7.8
    
    See Also:
    
    Constant Field Values
  - branch
```
protected java.lang.String branch
```
- Constructor Detail
  - BIC
```
public BIC(java.lang.String bic)
```
    Constructor with BIC code. It accepts a BIC8, BIC11 or a logical terminal address (12 characters) in which case the LT identifier at position 9 will be dropped.
    
    Parameters:
    
    bic - the BIC code to use in this BIC
    
    See Also:
    
    subclass to deal with 12 characters length LT identifiers
  - BIC
```
public BIC()
```
    Default constructor
- Method Detail
  - parse
```
protected void parse(java.lang.String bic)
```
    Parse the given string into the corresponding object attributes. Important: the LT identifier character is loss if parameter is 12 characters long
    
    Parameters:
    
    bic -
  - getBic
```
@Deprecated
 @ProwideDeprecated(phase4=_2018)
public java.lang.String getBic()
```
    Deprecated. use getBic8 or getBic11 instead
    
    Get the BIC code of this BIC. This method does not guarantee that the BIC is valid. use isValid()
    
    Returns:
    
    a string with the code
  - setBic
```
@Deprecated
 @ProwideDeprecated(phase4=_2018)
public void setBic(java.lang.String bic)
```
    Deprecated. use the constructor passing the string as parameter
    
    Parameters:
    
    bic - the BIC code
  - getInvalidCause
```
public java.lang.String getInvalidCause()
```
    Get a human readable (english) string that gives information about why the BIC was found invalid.
    
    Returns:
    
    a string or null if there's no invalid cause set
  - isValid
```
public boolean isValid()
```
    Validates a BIC structure. It only checks that length is 8 or 11 and that the country code is valid. This method does not validate against any BIC directory.
    
    Returns:
    
    true if the BIC is found to be valid and false in other case
    
    Throws:
    
    java.lang.IllegalStateException - if BIC is null
  - getBranch
```
public java.lang.String getBranch()
```
    It returns the last three that conform the branch or null if branch is not present.
    
    Returns:
    
    the BIC's branch part or null if not found.
    
    Since:
    
    7.8.5
  - getSubtype
```
public java.lang.String getSubtype()
```
    Since:
    
    7.4
  - setSubtype
```
public void setSubtype(java.lang.String subtype)
```
    Since:
    
    7.4
  - isTestAndTraining
```
public boolean isTestAndTraining()
```
    Returns true if the BIC is a Test & Training BIC code. In SWIFT’s FIN messaging system, a BIC with a zero in the 8th position is a Test & Training BIC, and as such it cannot be used in production FIN messages.
    
    Returns:
    
    true if it is a T&T BIC, false if is not or if the condition cannot be determined
    
    Since:
    
    7.6
  - isNonLive
```
public boolean isNonLive()
```
    Returns true if the BIC is not live (not connected) on the network.
    BICs can identify not only financial institutions but also non-financial ones either connected or not connected to the SWIFT network.
    A BIC of an institution which is not connected to the SWIFT network still has a location code with the digit 1 at the end (for instance AFSEUS31). BICs like that are called non-SWIFT BICs (or BIC 1).
    In SWIFT’s FIN messaging system, a BIC with a one in the 8th position is a Non-Live BIC.
    Note this is not the opposite of isLive()
    
    Returns:
    
    true if it is a Non-Live BIC, false if is not or if the condition cannot be determined
    
    Since:
    
    7.7
  - isLive
```
public boolean isLive()
```
    Returns true if the BIC is live (connected and not test & training) on the network. BICs can identify not only financial institutions but also non-financial ones either connected or not connected to the SWIFT network.
    In SWIFT’s FIN messaging system, a BIC with a character different than zero (that would be T&T) or one (that would be non-connected) in the 8th position is a Live BIC.
    Note this is not the opposite of isNonLive()
    
    Returns:
    
    true if it is a Non-Live BIC, false if is not or if the condition cannot be determined
    
    Since:
    
    7.7
  - getBic8
```
public java.lang.String getBic8()
```
    Returns the first 8 characters of the BIC code.
    
    Returns:
    
    the bic8 or null if the BIC has less than 8 characters
    
    Since:
    
    7.6
  - getBic11
```
public java.lang.String getBic11()
```
    Returns the BIC code with 11 characters composed by the first 8 characters of the BIC code, plus the branch code, dropping the logical terminal identifier at position 9 if present, and also padding with a default XXX branch if necessary.
    
    Returns:
    
    the bic8 or null if the BIC has less than 8 characters
    
    Since:
    
    7.6
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - country
```
public java.lang.String country()
```
    Gets the 2 chars country code of the BIC, which are the 5th and 6th characters
    
    Since:
    
    7.7
  - institution
```
public java.lang.String institution()
```
    Gets the first 4 characters of the BIC; corresponding to the institution code
    
    Since:
    
    7.8.5
  - distinguishedName
```
public java.lang.String distinguishedName()
```
    Returns the Distinguished Name (DN) for this BIC.
    The created DN always includes the BIC8 and "swift" and if the branch is present and not "XXX" it will also be included as organization unit (ou)
    
    Returns:
    
    ou=,o=,o=swift
    
    Since:
    
    7.9.3
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class BIC

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TEST8

TEST12

PARTNER_PREFIX

branch

Constructor Detail

BIC

BIC

Method Detail

parse

getBic

setBic

getInvalidCause

isValid

getBranch

getSubtype

setSubtype

isTestAndTraining

isNonLive

isLive

getBic8

getBic11

hashCode

equals

country

institution

distinguishedName

toString