Package org.apache.maven.plugins.changes

Class AbstractChangesReport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

org.apache.maven.plugins.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:

ChangesReport, GitHubChangesReport, JiraChangesReport, TracChangesReport

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

Fields

Modifier and Type	Field	Description
protected String	basedir	The current project base directory.
protected org.apache.maven.execution.MavenSession	mavenSession	The Maven Session.
protected boolean	runOnlyAtExecutionRoot	This will cause the execution to be run only at the top of a given module tree.

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
AbstractChangesReport()

Method Summary

Modifier and Type	Method	Description
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, constructXrefLocation, execute, executeReport, 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

getDescription, getName, getOutputName, getOutputPath

Field Details

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

Constructor Details

AbstractChangesReport

public AbstractChangesReport()

Method Details

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