org.apache.maven.plugin.changes
Class AbstractChangesReport

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.reporting.AbstractMavenReport
          org.apache.maven.plugin.changes.AbstractChangesReport

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:

ChangesMojo, GitHubMojo, JiraMojo, TracMojo

public abstract class AbstractChangesReport
extends org.apache.maven.reporting.AbstractMavenReport

Base class with the things that should be in AbstractMavenReport anyway. Note: This file was copied from r415312 of AbstractProjectInfoReport in maven-project-info-reports, as a work-around to MCHANGES-88.

Author:

Brett Porter

Field Summary

protected String	basedir The current project base directory.
protected org.apache.maven.artifact.factory.ArtifactFactory	factory
protected org.codehaus.plexus.i18n.I18N	i18n Internationalization.
protected org.apache.maven.artifact.repository.ArtifactRepository	localRepository Local Repository.
protected org.apache.maven.execution.MavenSession	mavenSession The Maven Session.
protected org.apache.maven.project.MavenProject	project The Maven Project.
protected org.apache.maven.artifact.resolver.ArtifactResolver	resolver
protected boolean	runOnlyAtExecutionRoot This will cause the execution to be run only at the top of a given module tree.
protected org.apache.maven.doxia.siterenderer.Renderer	siteRenderer Doxia Site Renderer.

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

AbstractChangesReport()

Method Summary

void	execute()
protected String	getOutputDirectory()
protected String	getOutputEncoding() Get the effective reporting output file encoding.
protected org.apache.maven.project.MavenProject	getProject()
protected org.apache.maven.doxia.siterenderer.Renderer	getSiteRenderer()
protected boolean	isThisTheExecutionRoot() Returns true if the current project is located at the Execution Root Directory (where mvn was launched).

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

canGenerateReport, closeReport, executeReport, 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

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

getDescription, getName, getOutputName

Field Detail

basedir

@Parameter(property="basedir",
           required=true)
protected String basedir

The current project base directory.

Since:

2.10

runOnlyAtExecutionRoot

@Parameter(property="changes.runOnlyAtExecutionRoot",
           defaultValue="false")
protected boolean runOnlyAtExecutionRoot

This will cause the execution to be run only at the top of a given module tree. That is, run in the project contained in the same folder where the mvn execution was launched.

Since:

2.10

mavenSession

@Parameter(defaultValue="${session}",
           readonly=true,
           required=true)
protected org.apache.maven.execution.MavenSession mavenSession

The Maven Session.

Since:

2.10

siteRenderer

@Component
protected org.apache.maven.doxia.siterenderer.Renderer siteRenderer

Doxia Site Renderer.

project

@Parameter(defaultValue="${project}",
           readonly=true,
           required=true)
protected org.apache.maven.project.MavenProject project

The Maven Project.

localRepository

@Parameter(property="localRepository",
           required=true,
           readonly=true)
protected org.apache.maven.artifact.repository.ArtifactRepository localRepository

Local Repository.

resolver

@Component
protected org.apache.maven.artifact.resolver.ArtifactResolver resolver

factory

@Component
protected org.apache.maven.artifact.factory.ArtifactFactory factory

i18n

@Component
protected org.codehaus.plexus.i18n.I18N i18n

Internationalization.

Constructor Detail

AbstractChangesReport

public AbstractChangesReport()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Overrides:

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

Throws:

org.apache.maven.plugin.MojoExecutionException

getOutputDirectory

protected String getOutputDirectory()

Overrides:

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

See Also:

AbstractMavenReport.getOutputDirectory()

getOutputEncoding

protected String getOutputEncoding()

Get the effective reporting output file encoding.

Overrides:

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

Returns:

The effective reporting output file encoding, never null.

Since:

2.4

getProject

protected org.apache.maven.project.MavenProject getProject()

Overrides:

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

See Also:

AbstractMavenReport.getProject()

getSiteRenderer

protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()

Overrides:

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

See Also:

AbstractMavenReport.getSiteRenderer()

isThisTheExecutionRoot

protected boolean isThisTheExecutionRoot()

Returns true if the current project is located at the Execution Root Directory (where mvn was launched).

Returns:

true if the current project is at the Execution Root