org.jdtaus.banking.util

Class BankleitzahlenDatei

java.lang.Object

org.jdtaus.banking.util.BankleitzahlenDatei

public final class BankleitzahlenDatei
extends Object

German Bankleitzahlendatei for the format as of 2006-06-01.

For further information see the Merkblatt Bankleitzahlendatei. An updated version of the document may be found at Deutsche Bundesbank.

Version:

$JDTAUS: BankleitzahlenDatei.java 8861 2014-01-10 17:09:50Z schulte $

Author:

Christian Schulte

Field Summary

Fields

Modifier and Type	Field and Description
static int	JUNE_2006_FORMAT Constant for the format as of june 2006.
static int	JUNE_2013_FORMAT Constant for the format as of june 2013.

Constructor Summary

Constructors

Constructor and Description
BankleitzahlenDatei(URL resource, int format, Date dateOfValidity, Date dateOfExpiration) Reads a Bankleitzahlendatei form an URL initializing the instance to hold its data taking a format constant.
BankleitzahlenDatei(URL resource, String encoding, int format, Date dateOfValidity, Date dateOfExpiration) Reads a Bankleitzahlendatei form an URL initializing the instance to hold its data taking the encoding of the file and a format constant.

Method Summary

Methods

Modifier and Type	Method and Description
BankleitzahlInfo[]	getBranchOfficeRecords(Bankleitzahl bankCode) Gets branch office records for a given bank code.
Date	getDateOfExpiration() Gets the date of expiration of the file.
Date	getDateOfValidity() Gets the date of validity of the file.
BankleitzahlInfo[]	getDeletedBranchOfficeRecords(Bankleitzahl bankCode) Gets deleted branch office records for a given bank code.
BankleitzahlInfo	getDeletedHeadOfficeRecord(Bankleitzahl bankCode) Gets a deleted head office record for a given bank code.
BankleitzahlInfo	getDeletedRecord(Integer serialNumber) Gets a deleted record identified by a serial number.
BankleitzahlInfo[]	getDeletedRecords() Gets all records deleted during updating.
String	getEncoding() Gets the encoding used for reading bankfile resources.
int	getFormat() Gets the format of the bankfile backing the instance.
BankleitzahlInfo	getHeadOfficeRecord(Bankleitzahl bankCode) Gets a head office record for a given bank code.
BankleitzahlInfo	getRecord(Integer serialNumber) Gets a record identified by a serial number.
BankleitzahlInfo[]	getRecords() Gets all records held by the instance.
void	update(BankleitzahlenDatei file) Given a newer version of the Bankleitzahlendatei updates the records of the instance to reflect the changes.

Methods inherited from class java.lang.Object

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

Field Detail

JUNE_2006_FORMAT

public static final int JUNE_2006_FORMAT

Constant for the format as of june 2006.

Since:

1.15

See Also:

Constant Field Values

JUNE_2013_FORMAT

public static final int JUNE_2013_FORMAT

Constant for the format as of june 2013.

Since:

1.15

See Also:

Constant Field Values

Constructor Detail

BankleitzahlenDatei

public BankleitzahlenDatei(URL resource,
                   int format,
                   Date dateOfValidity,
                   Date dateOfExpiration)
                    throws IOException

Reads a Bankleitzahlendatei form an URL initializing the instance to hold its data taking a format constant.

Parameters:

resource - An URL to a Bankleitzahlendatei.

format - The format of the file to parse.

dateOfValidity - The date of validity of the file.

dateOfExpiration - The date of expiration of the file.

Throws:

NullPointerException - if resource, dateOfValidity or dateOfExpiration is null.

PropertyException - for invalid property values.

IllegalArgumentException - if resource does not provide a valid Bankleitzahlendatei or if format does not equal one of the format constants defined in this class.

IOException - if reading fails.

See Also:

JUNE_2006_FORMAT, JUNE_2013_FORMAT

BankleitzahlenDatei

public BankleitzahlenDatei(URL resource,
                   String encoding,
                   int format,
                   Date dateOfValidity,
                   Date dateOfExpiration)
                    throws IOException

Reads a Bankleitzahlendatei form an URL initializing the instance to hold its data taking the encoding of the file and a format constant.

Parameters:

resource - An URL to a Bankleitzahlendatei.

encoding - The encoding to use when reading resource.

format - The format of the file to parse.

dateOfValidity - The date of validity of the file.

dateOfExpiration - The date of expiration of the file.

Throws:

NullPointerException - if resource, encoding, dateOfValidity or dateOfExpiration is null.

PropertyException - for invalid property values.

IllegalArgumentException - if resource does not provide a valid Bankleitzahlendatei or if format does not equal one of the format constants defined in this class.

IOException - if reading fails.

See Also:

JUNE_2006_FORMAT, JUNE_2013_FORMAT

Method Detail

getBranchOfficeRecords

public BankleitzahlInfo[] getBranchOfficeRecords(Bankleitzahl bankCode)

Gets branch office records for a given bank code.

Parameters:

bankCode - The bank code of the branch office records to return.

Returns:

The branch office records of the bank identified by bankCode.

Throws:

NullPointerException - if bankCode is null.

Since:

1.15

See Also:

getRecords(), BankleitzahlInfo.isHeadOffice()

getDateOfExpiration

public Date getDateOfExpiration()

Gets the date of expiration of the file.

Returns:

The date of expiration of the file or null, if the instance got created by using one of the deprecated constructors.

Since:

1.15

getDateOfValidity

public Date getDateOfValidity()

Gets the date of validity of the file.

Returns:

The date of validity of the file or null, if the instance got created by using one of the deprecated constructors.

Since:

1.15

getDeletedBranchOfficeRecords

public BankleitzahlInfo[] getDeletedBranchOfficeRecords(Bankleitzahl bankCode)

Gets deleted branch office records for a given bank code.

Parameters:

bankCode - The bank code of the deleted branch office records to return.

Returns:

The deleted branch office records of the bank identified by bankCode.

Throws:

NullPointerException - if bankCode is null.

Since:

1.15

See Also:

getDeletedRecords(), BankleitzahlInfo.isHeadOffice()

getDeletedHeadOfficeRecord

public BankleitzahlInfo getDeletedHeadOfficeRecord(Bankleitzahl bankCode)

Gets a deleted head office record for a given bank code.

Parameters:

bankCode - The bank code of the deleted head office record to return.

Returns:

The deleted head office record of the bank identified by bankCode or null, if no such record is found.

Throws:

NullPointerException - if bankCode is null.

Since:

1.15

See Also:

getDeletedRecords(), BankleitzahlInfo.isHeadOffice(), update(org.jdtaus.banking.util.BankleitzahlenDatei)

getDeletedRecord

public BankleitzahlInfo getDeletedRecord(Integer serialNumber)

Gets a deleted record identified by a serial number.

Parameters:

serialNumber - The serial number of the deleted record to return.

Returns:

The deleted record with serial number serialNumber or null, if no such record is found.

Throws:

NullPointerException - if serialNumber is null.

Since:

1.15

See Also:

getDeletedRecords(), update(org.jdtaus.banking.util.BankleitzahlenDatei)

getDeletedRecords

public BankleitzahlInfo[] getDeletedRecords()

Gets all records deleted during updating.

Returns:

All records deleted during updating.

Since:

1.15

See Also:

update(org.jdtaus.banking.util.BankleitzahlenDatei), update(org.jdtaus.banking.util.BankleitzahlenDatei)

getEncoding

public String getEncoding()

Gets the encoding used for reading bankfile resources.

Returns:

The encoding used for reading bankfile resources.

getFormat

public int getFormat()

Gets the format of the bankfile backing the instance.

Returns:

The format of the bankfile backing the instance.

Since:

1.15

getHeadOfficeRecord

public BankleitzahlInfo getHeadOfficeRecord(Bankleitzahl bankCode)

Gets a head office record for a given bank code.

Parameters:

bankCode - The bank code of the head office record to return.

Returns:

The head office record of the bank identified by bankCode or null, if no such record is found.

Throws:

NullPointerException - if bankCode is null.

Since:

1.15

See Also:

getRecords(), BankleitzahlInfo.isHeadOffice()

getRecord

public BankleitzahlInfo getRecord(Integer serialNumber)

Gets a record identified by a serial number.

Parameters:

serialNumber - The serial number of the record to return.

Returns:

The record with serial number serialNumber or null, if no record matching serialNumber exists in the file.

Throws:

NullPointerException - if serialNumber is null.

getRecords

public BankleitzahlInfo[] getRecords()

Gets all records held by the instance.

Returns:

All records held by the instance.

update

public void update(BankleitzahlenDatei file)

Given a newer version of the Bankleitzahlendatei updates the records of the instance to reflect the changes.

Parameters:

file - A newer version of the Bankleitzahlendatei to use for updating the records of this instance.

Throws:

NullPointerException - if file is null.

IllegalArgumentException - if file cannot be used for updating this instance.