org.apache.maven.plugin.jira
Class JiraReportGenerator

java.lang.Object
  org.apache.maven.plugin.jira.JiraReportGenerator

public class JiraReportGenerator

extends java.lang.Object

Generates a JIRA report.

Version:

$Id: JiraReportGenerator.html 816588 2012-05-08 12:37:27Z hboutemy $

Constructor Summary

JiraReportGenerator()

JiraReportGenerator(java.io.File xmlFile, java.lang.String columnNames, java.lang.String currentVersion, boolean onlyCurrentVersion)

Method Summary

void	doGenerateEmptyReport(java.util.ResourceBundle bundle, org.apache.maven.doxia.sink.Sink sink)
void	doGenerateReport(java.util.ResourceBundle bundle, org.apache.maven.doxia.sink.Sink sink, org.apache.maven.plugin.logging.Log log)
java.util.List	getIssuesForCurrentRelease(java.util.List allIssues) Find the issues for only the current release, by matching the "Fix for" version in the supplied list of issues with the current version from the pom.

Methods inherited from class java.lang.Object

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

Constructor Detail

JiraReportGenerator

public JiraReportGenerator()

JiraReportGenerator

public JiraReportGenerator(java.io.File xmlFile,
                           java.lang.String columnNames,
                           java.lang.String currentVersion,
                           boolean onlyCurrentVersion)
                    throws org.apache.maven.reporting.MavenReportException

Parameters:

xmlFile - An xml file containing issues from JIRA

columnNames - The names of the columns to include in the report

currentVersion - The current version of the project

onlyCurrentVersion - If only issues for the current version will be included in the report

Method Detail

doGenerateEmptyReport

public void doGenerateEmptyReport(java.util.ResourceBundle bundle,
                                  org.apache.maven.doxia.sink.Sink sink)

doGenerateReport

public void doGenerateReport(java.util.ResourceBundle bundle,
                             org.apache.maven.doxia.sink.Sink sink,
                             org.apache.maven.plugin.logging.Log log)
                      throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getIssuesForCurrentRelease

public java.util.List getIssuesForCurrentRelease(java.util.List allIssues)
                                          throws org.apache.maven.plugin.MojoExecutionException

Find the issues for only the current release, by matching the "Fix for" version in the supplied list of issues with the current version from the pom. If the current version is a SNAPSHOT, then that part of the version will be removed prior to the matching.

Parameters:

allIssues - A list of all issues from JIRA

Returns:

A List of issues for the current release of the current project

Throws:

org.apache.maven.plugin.MojoExecutionException - If no issues could be found for the current release