Package org.apache.maven.plugins.changelog

Class FileActivityReport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

org.apache.maven.plugins.changelog.ChangeLogReport

org.apache.maven.plugins.changelog.FileActivityReport

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenMultiPageReport, org.apache.maven.reporting.MavenReport

@Mojo(name="file-activity")
public class FileActivityReport
extends ChangeLogReport

Generate a file activity report.

Field Summary

Fields inherited from class org.apache.maven.plugins.changelog.ChangeLogReport

DEFAULT_ISSUE_ID_REGEX_PATTERN, developers, displayChangeSetDetailUrl, displayFileDetailUrl, displayFileRevDetailUrl, encodeFileUri, scmUrl, skip

Fields inherited from class org.apache.maven.reporting.AbstractMavenReport

outputDirectory, siteRenderer

Fields inherited from interface org.apache.maven.reporting.MavenReport

CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
FileActivityReport()

Method Summary

Modifier and Type	Method	Description
protected void	doGenerateEmptyReport(ResourceBundle bundle, org.apache.maven.doxia.sink.Sink sink)	generates an empty report in case there are no sources to generate a report with
protected void	doGenerateReport(List<org.apache.maven.scm.command.changelog.ChangeLogSet> changeLogSets, ResourceBundle bundle, org.apache.maven.doxia.sink.Sink sink)	method that generates the report for this mojo.
String	getDescription(Locale locale)
String	getName(Locale locale)
String	getOutputName()

Methods inherited from class org.apache.maven.plugins.changelog.ChangeLogReport

canGenerateReport, checkResult, countFilesChanged, doChangeSetTitle, doSummary, executeReport, generateChangeSetsFromSCM, generateLinks, generateLinks, getBundle, getChangedSets, getConnection, getOutputDirectory, getOutputEncoding, getProject, getScmRepository, getSiteRenderer, initReportUrls, sinkAuthorDetails

Methods inherited from class org.apache.maven.reporting.AbstractMavenReport

closeReport, execute, generate, generate, generate, getCategoryName, getInputEncoding, getReportOutputDirectory, getSink, getSinkFactory, isExternalReport, setReportOutputDirectory

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Constructor Details

FileActivityReport

public FileActivityReport()

Method Details

getDescription

public String getDescription(Locale locale)

Specified by:

getDescription in interface org.apache.maven.reporting.MavenReport

Overrides:

getDescription in class ChangeLogReport

getName

public String getName(Locale locale)

Specified by:

getName in interface org.apache.maven.reporting.MavenReport

Overrides:

getName in class ChangeLogReport

getOutputName

public String getOutputName()

Specified by:

getOutputName in interface org.apache.maven.reporting.MavenReport

Overrides:

getOutputName in class ChangeLogReport

doGenerateEmptyReport

protected void doGenerateEmptyReport(ResourceBundle bundle,
 org.apache.maven.doxia.sink.Sink sink)

generates an empty report in case there are no sources to generate a report with

Overrides:

doGenerateEmptyReport in class ChangeLogReport

Parameters:

bundle - the resource bundle to retrieve report phrases from

sink - the report formatting tool

doGenerateReport

protected void doGenerateReport(List<org.apache.maven.scm.command.changelog.ChangeLogSet> changeLogSets,
 ResourceBundle bundle,
 org.apache.maven.doxia.sink.Sink sink)

method that generates the report for this mojo. This method is overridden by dev-activity and file-activity mojo

Overrides:

doGenerateReport in class ChangeLogReport

Parameters:

changeLogSets - changed sets to generate the report from

bundle - the resource bundle to retrieve report phrases from

sink - the report formatting tool