org.jdtaus.banking.ri.blzdirectory

Class DefaultBankfileProvider

java.lang.Object

org.jdtaus.banking.ri.blzdirectory.AbstractPropertiesBankfileProvider

org.jdtaus.banking.ri.blzdirectory.DefaultBankfileProvider

All Implemented Interfaces:

BankfileProvider

public final class DefaultBankfileProvider
extends AbstractPropertiesBankfileProvider

Default BankfileProvider implementation backed by a property file.

Version:

$JDTAUS: DefaultBankfileProvider.java 8865 2014-01-10 17:13:42Z schulte $

Author:

Christian Schulte

See Also:

BankfileBankleitzahlenVerzeichnis

Constructor Summary

Constructors

Constructor and Description
DefaultBankfileProvider() Standard implementation constructor org.jdtaus.banking.ri.blzdirectory.DefaultBankfileProvider.
DefaultBankfileProvider(ClassLoader classLoader, String classpathLocation, String propertiesResourceName) Creates a new ClasspathBankfileProvider instance taking a class loader to search for resources, a location resources are searched at and the name of the properties resource backing the instance.

Method Summary

Methods

Modifier and Type	Method and Description
URL	getBankfile(int index) Gets a bankfile resource.
ClassLoader	getClassLoader() Gets the class loader searched for resources.
String	getClasspathLocation() Gets the classpath location searched for resources.
Properties	getProperties() Gets the properties backing the instance.
String	getPropertiesResourceName() Gets the name of the properties resource backing the instance.

Methods inherited from class org.jdtaus.banking.ri.blzdirectory.AbstractPropertiesBankfileProvider

getBankfileCount, getBankfileLocation, getDateOfExpiration, getDateOfValidity, getFormat, getLastModifiedMillis, setProperties

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultBankfileProvider

public DefaultBankfileProvider()

Standard implementation constructor org.jdtaus.banking.ri.blzdirectory.DefaultBankfileProvider.

DefaultBankfileProvider

public DefaultBankfileProvider(ClassLoader classLoader,
                       String classpathLocation,
                       String propertiesResourceName)

Creates a new ClasspathBankfileProvider instance taking a class loader to search for resources, a location resources are searched at and the name of the properties resource backing the instance.

Parameters:

classLoader - Class loader to search for resources or null.

classpathLocation - Location to search resources at or null.

propertiesResourceName - Name of the properties resource backing the instance or null.

Method Detail

getBankfile

public URL getBankfile(int index)
                throws IOException

Description copied from interface: BankfileProvider

Gets a bankfile resource.

Parameters:

index - The index of the bankfile resource to get.

Returns:

The bankfile resource at index.

Throws:

IOException - if getting the bankfile resource fails.

getClassLoader

public ClassLoader getClassLoader()

Gets the class loader searched for resources.

This method returns either the current thread's context class loader or this classes class loader, if the current thread has no context class loader set. A custom class loader can be specified by using one of the constructors taking a class loader.

Returns:

The class loader searched for resources.

getClasspathLocation

public String getClasspathLocation()

Gets the classpath location searched for resources.

Returns:

The classpath location searched for resources.

getProperties

public Properties getProperties()
                         throws IOException

Gets the properties backing the instance.

Overrides:

getProperties in class AbstractPropertiesBankfileProvider

Returns:

The properties backing the instance.

Throws:

IOException - if loading the properties fails.

getPropertiesResourceName

public String getPropertiesResourceName()

Gets the name of the properties resource backing the instance.

Returns:

The name of the properties resource backing the instance.