org.xbib.standardnumber

Class IBAN

java.lang.Object

org.xbib.standardnumber.StandardNumber

org.xbib.standardnumber.IBAN

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable<IBAN>

public class IBAN
extends StandardNumber
implements java.lang.Cloneable, java.lang.Comparable<IBAN>

ISO 13616 International Bank Account Number (IBAN).

The International Bank Account Number (IBAN) is an internationally agreed means of identifying bank accounts across national borders with a reduced risk of transcription errors. It was originally adopted by the European Committee for Banking Standards (ECBS) and later as an international standard under ISO 13616:1997. The current standard is ISO 13616:2007, which indicates SWIFT as the formal registrar.

Checksum calculation is in accordance to ISO 7064 MOD-97.

Field Summary

Fields inherited from class org.xbib.standardnumber.StandardNumber

type, value

Constructor Summary

Constructors

Constructor and Description
IBAN()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Returns a clone if the implementation is cloneable.
int	compareTo(IBAN iban)
IBAN	createChecksum(boolean createWithChecksum) Indicate that a correct check sum should be computed.
boolean	equals(java.lang.Object object)
java.lang.String	format() Return a formatted value of this standard number This is best for human-readable representation, but is not necessarily a format for computation.
static StandardNumber	getInstance(java.lang.Package thePackage, java.lang.ClassLoader classLoader, java.lang.String type)
static StandardNumber	getInstance(java.lang.String type)
java.util.Collection<java.lang.String>	getTypedVariants()
int	hashCode()
boolean	isValid() Check this number for validity.
IBAN	normalize() Normalize the value by removing all unwanted characters or replacing characters with the ones required for verification.
java.lang.String	normalizedValue() Return normalized value of this standard number.
IBAN	reset()
IBAN	verify() Verify the number.

Methods inherited from class org.xbib.standardnumber.StandardNumber

set, type

Methods inherited from class java.lang.Object

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

Constructor Detail

IBAN

public IBAN()

Method Detail

compareTo

public int compareTo(IBAN iban)

Specified by:

compareTo in interface java.lang.Comparable<IBAN>

createChecksum

public IBAN createChecksum(boolean createWithChecksum)

Description copied from class: StandardNumber

Indicate that a correct check sum should be computed.

Specified by:

createChecksum in class StandardNumber

Parameters:

createWithChecksum - if checksum is included

Returns:

this standard number

normalize

public IBAN normalize()

Description copied from class: StandardNumber

Normalize the value by removing all unwanted characters or replacing characters with the ones required for verification.

Specified by:

normalize in class StandardNumber

Returns:

this standard number

isValid

public boolean isValid()

Description copied from class: StandardNumber

Check this number for validity.

Specified by:

isValid in class StandardNumber

Returns:

true if valid, false otherwise

verify

public IBAN verify()

Description copied from class: StandardNumber

Verify the number.

Specified by:

verify in class StandardNumber

Returns:

this standard number if verification was successful

normalizedValue

public java.lang.String normalizedValue()

Description copied from class: StandardNumber

Return normalized value of this standard number. In most cases, this is also the canonical form of the standard number. This is a representation without unneccessary characters, useful for computation purposes, like comparing for equivalence.

Specified by:

normalizedValue in class StandardNumber

Returns:

the normalized value

format

public java.lang.String format()

Description copied from class: StandardNumber

Return a formatted value of this standard number This is best for human-readable representation, but is not necessarily a format for computation.

Specified by:

format in class StandardNumber

Returns:

a formatted value

reset

public IBAN reset()

Specified by:

reset in class StandardNumber

getTypedVariants

public java.util.Collection<java.lang.String> getTypedVariants()

Specified by:

getTypedVariants in class StandardNumber

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Returns a clone if the implementation is cloneable.

Returns:

a clone if the implementation is cloneable.

Throws:

java.lang.CloneNotSupportedException - if this is called on an implementation that does not support `Cloneable`

getInstance

public static StandardNumber getInstance(java.lang.String type)
                                  throws NoSuchStandardNumberException

Throws:

NoSuchStandardNumberException

getInstance

public static StandardNumber getInstance(java.lang.Package thePackage,
                                         java.lang.ClassLoader classLoader,
                                         java.lang.String type)
                                  throws NoSuchStandardNumberException

Throws:

NoSuchStandardNumberException