Package org.apache.maven.plugins.changes

Class ChangesReport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

org.apache.maven.plugins.changes.AbstractChangesReport

org.apache.maven.plugins.changes.ChangesReport

All Implemented Interfaces:

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

Direct Known Subclasses:

ChangesDeprecatedReport

@Mojo(name="changes",
      threadSafe=true)
public class ChangesReport
extends AbstractChangesReport

Goal which creates a nicely formatted Changes Report in html format from a changes.xml file.

Since:

2.0

Author:

Johnny R. Ruiz III

Field Summary

Fields inherited from class org.apache.maven.plugins.changes.AbstractChangesReport

basedir, mavenSession, runOnlyAtExecutionRoot

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

locale, mojoExecution, outputDirectory, outputFormat, outputTimestamp, project, reactorProjects, remoteProjectRepositories, repoSession, siteDirectory, siteRenderer, siteTool

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
ChangesReport(org.apache.maven.shared.filtering.MavenFileFilter mavenFileFilter)

Method Summary

Modifier and Type	Method	Description
boolean	canGenerateReport()
void	executeReport(Locale locale)
String	getDescription(Locale locale)
String	getName(Locale locale)
String	getOutputName()	Deprecated.

Methods inherited from class org.apache.maven.plugins.changes.AbstractChangesReport

isThisTheExecutionRoot

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

closeReport, constructXrefLocation, execute, generate, generate, getCategoryName, getInputEncoding, getLocale, getOutputDirectory, getOutputEncoding, getProject, getReportOutputDirectory, getSink, getSinkFactory, getSiteRenderer, getXrefLocation, 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

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

getOutputPath

Constructor Details

ChangesReport

@Inject
public ChangesReport(org.apache.maven.shared.filtering.MavenFileFilter mavenFileFilter)

Method Details

canGenerateReport

public boolean canGenerateReport()

Specified by:

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

Overrides:

canGenerateReport in class org.apache.maven.reporting.AbstractMavenReport

executeReport

public void executeReport(Locale locale)
                   throws org.apache.maven.reporting.MavenReportException

Specified by:

executeReport in class org.apache.maven.reporting.AbstractMavenReport

Throws:

org.apache.maven.reporting.MavenReportException

getDescription

public String getDescription(Locale locale)

getName

public String getName(Locale locale)

getOutputName

@Deprecated
public String getOutputName()

Deprecated.