b4j.report

Class AbstractFileReport

java.lang.Object

b4j.report.AbstractReportGenerator

b4j.report.AbstractFileReport

All Implemented Interfaces:

BugzillaReportGenerator

Direct Known Subclasses:

AssigneeTrackingReport, ChangeLogReport, DetailedBugReport, ManagementTrackingReport

public abstract class AbstractFileReport
extends AbstractReportGenerator

Abstract implementation for reports that generate a file on a local disk.

This class already implements default methods for most of the interface's methods. So you usually just need to implement BugzillaReportGenerator.closeReport().

Author:

Ralph Schuster

Constructor Summary

Constructors

Constructor and Description
AbstractFileReport() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
File	getOutputFile() Returns the configured output file.
OutputStream	getOutputStream() Returns the stream to the output file.
void	init(org.apache.commons.configuration.Configuration config) Configures the file report.

Methods inherited from class b4j.report.AbstractReportGenerator

getBugzillaSession, getMaximumBugzillaVersion, getMinimumBugzillaVersion, prepareReport, setBugzillaSession

Methods inherited from class java.lang.Object

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

Methods inherited from interface b4j.report.BugzillaReportGenerator

closeReport, registerBug

Constructor Detail

AbstractFileReport

public AbstractFileReport()

Default constructor.

Method Detail

init

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

Configures the file report. This implementation retrieves the value for "outputFile" or throws an exception when no such element was defined.

Specified by:

init in interface BugzillaReportGenerator

Overrides:

init in class AbstractReportGenerator

Parameters:

config - - the configuration object

Throws:

org.apache.commons.configuration.ConfigurationException - - when a configuration problem occurs

getOutputFile

public File getOutputFile()

Returns the configured output file.

Returns:

the output file

getOutputStream

public OutputStream getOutputStream()

Returns the stream to the output file.

Returns:

the output stream to our file