Class CheckstyleAggregateReport
java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.reporting.AbstractMavenReport
org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
org.apache.maven.plugins.checkstyle.CheckstyleAggregateReport
- All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled
,org.apache.maven.plugin.Mojo
,org.apache.maven.reporting.MavenMultiPageReport
,org.apache.maven.reporting.MavenReport
@Mojo(name="checkstyle-aggregate",
aggregator=true,
requiresDependencyResolution=COMPILE,
threadSafe=true)
public class CheckstyleAggregateReport
extends AbstractCheckstyleReport
A reporting task that performs Checkstyle analysis and generates an aggregate
HTML report on the violations that Checkstyle finds in a multi-module reactor
build.
- Version:
- $Id$
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate List<org.apache.maven.project.MavenProject>
The projects in the reactor for aggregation report.Fields inherited from class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
cacheFile, checkstyleExecutor, checkstyleRssGenerator, configLocation, consoleOutput, encoding, excludes, failsOnError, headerLocation, includeResources, includes, includeTestResources, includeTestSourceDirectory, JAVA_FILES, locator, PLUGIN_RESOURCES, propertiesLocation, propertyExpansion, resourceExcludes, resourceIncludes, resources, siteTool, skip, stringOutputStream, suppressionsFileExpression, suppressionsLocation, testResources
Fields inherited from class org.apache.maven.reporting.AbstractMavenReport
outputDirectory, project, siteRenderer
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 -
Method Summary
Modifier and TypeMethodDescriptionboolean
protected CheckstyleExecutorRequest
Create the Checkstyle executor request.protected org.apache.maven.project.MavenProject
Methods inherited from class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
executeReport, getConsoleListener, getDescription, getListener, getName, getSourceDirectories, getTestSourceDirectories
Methods inherited from class org.apache.maven.reporting.AbstractMavenReport
closeReport, execute, generate, generate, generate, getCategoryName, getInputEncoding, getOutputDirectory, getOutputEncoding, getReportOutputDirectory, getSink, getSinkFactory, getSiteRenderer, isExternalReport, setReportOutputDirectory
Methods inherited from class org.apache.maven.plugin.AbstractMojo
getLog, getPluginContext, setLog, setPluginContext
-
Field Details
-
reactorProjects
@Parameter(property="reactorProjects", readonly=true) private List<org.apache.maven.project.MavenProject> reactorProjectsThe projects in the reactor for aggregation report.- Since:
- 2.8
-
-
Constructor Details
-
CheckstyleAggregateReport
public CheckstyleAggregateReport()
-
-
Method Details
-
getProject
protected org.apache.maven.project.MavenProject getProject()- Overrides:
getProject
in classorg.apache.maven.reporting.AbstractMavenReport
-
createRequest
protected CheckstyleExecutorRequest createRequest() throws org.apache.maven.reporting.MavenReportExceptionCreate the Checkstyle executor request.- Specified by:
createRequest
in classAbstractCheckstyleReport
- Returns:
- The executor request.
- Throws:
org.apache.maven.reporting.MavenReportException
- If something goes wrong during creation.
-
getOutputName
-
canGenerateReport
public boolean canGenerateReport()- Specified by:
canGenerateReport
in interfaceorg.apache.maven.reporting.MavenReport
- Overrides:
canGenerateReport
in classorg.apache.maven.reporting.AbstractMavenReport
-