org.apache.maven.plugin.changes
Class AbstractChangesReport

java.lang.Object
  extended by org.apache.maven.plugin.AbstractMojo
      extended by org.apache.maven.reporting.AbstractMavenReport
          extended by 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

Field Summary
protected  String basedir
          The current project base directory.
protected  ArtifactFactory factory
           
protected  I18N i18n
          Internationalization.
protected  ArtifactRepository localRepository
          Local Repository.
protected  MavenSession mavenSession
          The Maven Session.
protected  MavenProject project
          The Maven Project.
protected  ArtifactResolver resolver
           
protected  boolean runOnlyAtExecutionRoot
          This will cause the execution to be run only at the top of a given module tree.
protected  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  MavenProject getProject()
           
protected  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, 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

@Component
protected MavenSession mavenSession
The Maven Session.

Since:
2.10

siteRenderer

@Component
protected Renderer siteRenderer
Doxia Site Renderer.


project

@Component
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.

Constructor Detail

AbstractChangesReport

public AbstractChangesReport()
Method Detail

execute

public void execute()
             throws MojoExecutionException
Specified by:
execute in interface Mojo
Overrides:
execute in class AbstractMavenReport
Throws:
MojoExecutionException

getOutputDirectory

protected String getOutputDirectory()
Specified by:
getOutputDirectory in class AbstractMavenReport
See Also:
AbstractMavenReport.getOutputDirectory()

getOutputEncoding

protected String getOutputEncoding()
Get the effective reporting output file encoding.

Returns:
The effective reporting output file encoding, never null.
Since:
2.4

getProject

protected MavenProject getProject()
Specified by:
getProject in class AbstractMavenReport
See Also:
AbstractMavenReport.getProject()

getSiteRenderer

protected Renderer getSiteRenderer()
Specified by:
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


Copyright © 2002–2014 The Apache Software Foundation. All rights reserved.