public class ChangeLogReport extends AbstractFileReport
Issue.isClosed()).
The change log is a text file that lists all defined releases in configuration
along with id and summaries of each bug fixed. A release is defined with name
and timestamp within configuration.
This implementation does not evaluate the version information of a bug.
| Modifier and Type | Class and Description |
|---|---|
protected class |
ChangeLogReport.ReleaseComparator
Implements the sorting of releases.
|
| Constructor and Description |
|---|
ChangeLogReport()
Constructor.
|
| Modifier and Type | Method and Description |
|---|---|
void |
closeReport()
Closes a report.
|
protected String |
getBugText(Issue bug)
Returns the text for a bug record to appear in Change Log.
|
protected Release |
getRelease(Issue bug)
Maps the bug's last change date to a release.
|
protected String |
getReleaseText(Release r)
Returns the text for a release to appear.
|
void |
init(org.apache.commons.configuration.Configuration config)
Reads the configuration for the ChangeLog.
|
void |
registerBug(Issue bug)
Registers a bug for the report.
|
getOutputFile, getOutputStreamgetBugzillaSession, getMaximumBugzillaVersion, getMinimumBugzillaVersion, prepareReport, setBugzillaSessionpublic void init(org.apache.commons.configuration.Configuration config)
throws org.apache.commons.configuration.ConfigurationException
<outputFile>D:/ChangeLog.txt</outputFile>
<Version timestamp="2008-06-10 00:00">
<Name>Release 1.1</Name>
<Include>
All SL Use cases - UC Descriptions reworked\, amended and created
All SL Use cases - VD11 default sorting stated more precisely
</Version>
<Version timestamp="2008-07-16 00:00">
<Name>Release 1.2</Name>
<Include>UC55 - VD23 Description updated
</Include>
</Version>
<Version timestamp="2008-08-08 00:00">
<Name>Release 2.0</Name>
</Version>
Include lines are taken over into the Change Log.
Timestamps give the time of the release closure. All bugs closed until that time will be considered for the ChangeLog of that release.
The Name tag assigns a name to your release.
init in interface BugzillaReportGeneratorinit in class AbstractFileReportconfig - - the configuration objectorg.apache.commons.configuration.ConfigurationException - - when a configuration problem occursAbstractFileReport.init(org.apache.commons.configuration.Configuration)public void registerBug(Issue bug)
bug - - the bug to collect data fromBugzillaReportGenerator.registerBug(b4j.core.Issue)protected String getBugText(Issue bug)
bug - - the bug to generate the text fromprotected Release getRelease(Issue bug)
bug - - the bug to considerpublic void closeReport()
protected String getReleaseText(Release r)
r - - the release to generate the header text fromCopyright © 2012. All Rights Reserved.