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

Fields
Modifier and Type Field Description

private java.util.List<org.apache.maven.project.MavenProject> reactorProjects
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
  localRepository, outputDirectory, project, remoteRepositories, 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
Constructor Description

CheckstyleAggregateReport()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`canGenerateReport()`
`protected CheckstyleExecutorRequest`	`createRequest()`	Create the Checkstyle executor request.
`java.lang.String`	`getOutputName()`
`protected org.apache.maven.project.MavenProject`	`getProject()`

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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - reactorProjects
```
@Parameter(property="reactorProjects",
           readonly=true)
private java.util.List<org.apache.maven.project.MavenProject> reactorProjects
```
    The projects in the reactor for aggregation report.
    
    Since:
    
    2.8
- Constructor Detail
  - CheckstyleAggregateReport
```
public CheckstyleAggregateReport()
```
- Method Detail
  - getProject
```
protected org.apache.maven.project.MavenProject getProject()
```
    Overrides:
    
    getProject in class org.apache.maven.reporting.AbstractMavenReport
  - createRequest
```
protected CheckstyleExecutorRequest createRequest()
                                           throws org.apache.maven.reporting.MavenReportException
```
    Create the Checkstyle executor request.
    
    Specified by:
    
    createRequest in class AbstractCheckstyleReport
    
    Returns:
    
    The executor request.
    
    Throws:
    
    org.apache.maven.reporting.MavenReportException - If something goes wrong during creation.
  - getOutputName
```
public java.lang.String getOutputName()
```
  - canGenerateReport
```
public boolean canGenerateReport()
```
    Specified by:
    
    canGenerateReport in interface org.apache.maven.reporting.MavenReport
    
    Overrides:
    
    canGenerateReport in class org.apache.maven.reporting.AbstractMavenReport