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:

ContextEnabled, Mojo, MavenMultiPageReport, MavenReport

Direct Known Subclasses:

ChangesMojo, GitHubMojo, JiraMojo, TracMojo

public abstract class AbstractChangesReport
extends 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

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 MavenSession mavenSession

The Maven Session.

Since:

2.10

siteRenderer

@Component
protected Renderer siteRenderer

Doxia Site Renderer.

project

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

The Maven Project.

localRepository

@Parameter(property="localRepository",
           required=true,
           readonly=true)
protected ArtifactRepository localRepository

Local Repository.

resolver

@Component
protected ArtifactResolver resolver

factory

@Component
protected ArtifactFactory factory

i18n

@Component
protected I18N i18n

Internationalization.

AbstractChangesReport

public AbstractChangesReport()

execute

public void execute()
             throws MojoExecutionException

Specified by:

execute in interface Mojo

Overrides:

execute in class AbstractMavenReport

Throws:

MojoExecutionException

getOutputDirectory

protected String getOutputDirectory()

Overrides:

getOutputDirectory in class AbstractMavenReport

See Also:

AbstractMavenReport.getOutputDirectory()

getOutputEncoding

protected String getOutputEncoding()

Get the effective reporting output file encoding.

Overrides:

getOutputEncoding in class AbstractMavenReport

Returns:

The effective reporting output file encoding, never null.

Since:

2.4

getProject

protected MavenProject getProject()

Overrides:

getProject in class AbstractMavenReport

See Also:

AbstractMavenReport.getProject()

getSiteRenderer

protected Renderer getSiteRenderer()

Overrides:

getSiteRenderer in class 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