b4j.report

Class AbstractFileReleaseProvider

java.lang.Object

b4j.report.DefaultReleaseProvider

b4j.report.AbstractFileReleaseProvider

All Implemented Interfaces:

Configurable, ReleaseProvider

Direct Known Subclasses:

TextFileReleaseProvider, XmlFileReleaseProvider

public abstract class AbstractFileReleaseProvider
extends DefaultReleaseProvider

Abstract implementations for release providers that load release information from external files. The main purpose of this class is to allow sub-classes to load their release information from an external file, such as property files, text files or XML files. This allows you to flexible configure the release information without having the main configuration to be changed.

Author:

Ralph Schuster

Constructor Summary

Constructors

Constructor and Description
AbstractFileReleaseProvider() Default Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	configure(org.apache.commons.configuration.Configuration config) Configures the provider.
protected abstract void	loadReleases(File file) Loads the releases.

Methods inherited from class b4j.report.DefaultReleaseProvider

addRelease, getReleases, releaseExists, removeRelease

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractFileReleaseProvider

public AbstractFileReleaseProvider()

Default Constructor.

Method Detail

configure

public void configure(org.apache.commons.configuration.Configuration config)
               throws org.apache.commons.configuration.ConfigurationException

Configures the provider. The method will read all information from the file given as configuration element <File>.

You can allow loading releases directly from configuration as parent class DefaultReleaseProvider does by setting element <ignoreConfigReleases> to false. The default behaviour is to ignore all releases mentioned in the configuration object but loading all from the external file.

Release information in external files always takes precedence over configured information.

Specified by:

configure in interface Configurable

Overrides:

configure in class DefaultReleaseProvider

Parameters:

config - - configuration object

Throws:

org.apache.commons.configuration.ConfigurationException - - when configuration fails

loadReleases

protected abstract void loadReleases(File file)
                              throws org.apache.commons.configuration.ConfigurationException

Loads the releases.

Parameters:

file - - file to load releases from

Throws:

org.apache.commons.configuration.ConfigurationException - - if an error occurs