com.prowidesoftware.swift.model

Class BIC

java.lang.Object

com.prowidesoftware.swift.model.BIC

Direct Known Subclasses:

LogicalTerminalAddress

public class BIC
extends Object

Helper class to process BIC related information.

Since:

3.3

Author:

www.prowidesoftware.com

Field Summary

Fields

Modifier and Type	Field and Description
static String	TEST12 Fake Logical terminal address for testing, consisting of a fake "test & training" BIC of 12 chars (including the terminal identification)
static String	TEST8 Fake "test & training" BIC of 8 chars for testing

Constructor Summary

Constructors

Constructor and Description
BIC() Default constructor
BIC(String bic) Constructor with BIC code.

Method Summary

Methods

Modifier and Type	Method and Description
String	country() Gets the 2 chars country code of the BIC, which are the 5th and 6th characters
boolean	equals(Object obj)
String	getBic() Deprecated. use getBic8 or getBic11 instead
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.
String	getBic8() Returns the first 8 characters of the BIC code.
String	getInvalidCause() Get a human readable (english) string that gives information about why the BIC was found invalid.
String	getSubtype()
int	hashCode()
boolean	isLive() Returns true if the BIC is live on the network.
boolean	isNonLive() Returns true if the BIC is not live on the network.
boolean	isTestAndTraining() Returns true if the BIC is a Test & Training BIC code.
boolean	isValid() Validates a BIC structure.
void	setBic(String bic) Deprecated. use the constructor passing the string as parameter
void	setSubtype(String subtype)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

TEST8

public static final transient String TEST8

Fake "test & training" BIC of 8 chars for testing

Since:

7.6

See Also:

Constant Field Values

TEST12

public static final transient 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

Constructor Detail

BIC

public BIC(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

BIC

public BIC()

Default constructor

Method Detail

getBic

@Deprecated
public 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
public void setBic(String bic)

Deprecated. use the constructor passing the string as parameter

Parameters:

bic - the BIC code

getInvalidCause

public 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:

IllegalStateException - if BIC is null

getSubtype

public String getSubtype()

Since:

7.4

setSubtype

public void setSubtype(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 on the network. In SWIFT’s FIN messaging system, a BIC with a one in the 8th position is a Non-Live BIC.

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 on the network. In SWIFT’s FIN messaging system, a BIC with a character different than zero or one in the 8th position is a Live BIC.

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 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 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 Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

country

public String country()

Gets the 2 chars country code of the BIC, which are the 5th and 6th characters

Since:

7.7