org.jdtaus.banking.ri.blzdirectory

Class AbstractPropertiesBankfileProvider

java.lang.Object

org.jdtaus.banking.ri.blzdirectory.AbstractPropertiesBankfileProvider

All Implemented Interfaces:

BankfileProvider

Direct Known Subclasses:

DefaultBankfileProvider

public abstract class AbstractPropertiesBankfileProvider
extends Object
implements BankfileProvider

BankfileProvider implementation backed by a properties file.

Version:

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

Author:

Christian Schulte

See Also:

BankfileBankleitzahlenVerzeichnis

Constructor Summary

Constructors

Constructor and Description
AbstractPropertiesBankfileProvider() Creates a new AbstractPropertiesBankfileProvider instance.

Method Summary

Methods

Modifier and Type	Method and Description
int	getBankfileCount() Gets the number of provided bankfile resources.
String	getBankfileLocation(int index) Gets a bankfile resource location.
Date	getDateOfExpiration(int index) Gets the date of expiration of a bankfile resource.
Date	getDateOfValidity(int index) Gets the date of validity of a bankfile resource.
int	getFormat(int index) Gets the format of the bankfile resource.
long	getLastModifiedMillis() Gets the timestamp this provider was last modified.
Properties	getProperties() Gets the properties of the instance.
void	setProperties(Properties value) Sets the properties of the instance.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jdtaus.banking.ri.blzdirectory.BankfileProvider

getBankfile

Constructor Detail

AbstractPropertiesBankfileProvider

public AbstractPropertiesBankfileProvider()

Creates a new AbstractPropertiesBankfileProvider instance.

Method Detail

getBankfileCount

public final int getBankfileCount()
                           throws IOException

Description copied from interface: BankfileProvider

Gets the number of provided bankfile resources.

Specified by:

getBankfileCount in interface BankfileProvider

Returns:

The number of provided bankfile resources.

Throws:

IOException - if getting the number of provided bankfile resources fails.

getBankfileLocation

public String getBankfileLocation(int index)
                           throws IOException

Gets a bankfile resource location.

Parameters:

index - The index of the bankfile resource location to get.

Returns:

The bankfile resource location at index.

Throws:

IndexOutOfBoundsException - if index is negative or greater or equal to the value returned by method getBankfileCount().

IOException - if getting the bankfile resource location fails.

getDateOfExpiration

public final Date getDateOfExpiration(int index)
                               throws IOException

Description copied from interface: BankfileProvider

Gets the date of expiration of a bankfile resource.

Specified by:

getDateOfExpiration in interface BankfileProvider

Parameters:

index - The index of the bankfile resource to get the date of expiration of.

Returns:

The date of expiration of the bankfile resource index.

Throws:

IOException - if getting the date of expiration fails.

getDateOfValidity

public final Date getDateOfValidity(int index)
                             throws IOException

Description copied from interface: BankfileProvider

Gets the date of validity of a bankfile resource.

Specified by:

getDateOfValidity in interface BankfileProvider

Parameters:

index - The index of the bankfile resource to get the date of validity of.

Returns:

The date of validity of the bankfile resource index.

Throws:

IOException - if getting the date of validity fails.

getFormat

public final int getFormat(int index)
                    throws IOException

Description copied from interface: BankfileProvider

Gets the format of the bankfile resource.

Specified by:

getFormat in interface BankfileProvider

Parameters:

index - The index of the bankfile resource to get the format of.

Returns:

The format of the bankfile resource.

Throws:

IOException - if getting the format of the bankfile resource fails.

See Also:

BankleitzahlenDatei.JUNE_2006_FORMAT, BankleitzahlenDatei.JUNE_2013_FORMAT

getLastModifiedMillis

public long getLastModifiedMillis()
                           throws IOException

Description copied from interface: BankfileProvider

Gets the timestamp this provider was last modified.

Specified by:

getLastModifiedMillis in interface BankfileProvider

Returns:

The timestamp this provider was last modified.

Throws:

IOException - if getting the last modification timestamp fails.

getProperties

public Properties getProperties()
                         throws IOException

Gets the properties of the instance.

Returns:

The properties of the instance.

Throws:

IOException - if getting the properties fails.

setProperties

public void setProperties(Properties value)

Sets the properties of the instance.

Parameters:

value - The new properties of the instance or null.