org.apache.maven.plugin.checkstyle
Class CheckstyleAggregateReport

java.lang.Object
  extended by org.apache.maven.plugin.AbstractMojo
      extended by org.apache.maven.reporting.AbstractMavenReport
          extended by org.apache.maven.plugin.checkstyle.AbstractCheckstyleReport
              extended by org.apache.maven.plugin.checkstyle.CheckstyleAggregateReport
All Implemented Interfaces:
ContextEnabled, Mojo, MavenMultiPageReport, MavenReport

public class CheckstyleAggregateReport
extends AbstractCheckstyleReport

Perform a Checkstyle analysis, and generate a report on violations, aggregating the result in the project which started this mojo.

Since:
2.8
Version:
$Id: CheckstyleAggregateReport.html 816673 2012-05-08 14:06:16Z hboutemy $
Aggregates the Maven project and its child modules.
Is defined by the goal name:
checkstyle-aggregate
Requires the dependencies in this specified scope:
compile

Field Summary
 
Fields inherited from class org.apache.maven.plugin.checkstyle.AbstractCheckstyleReport
checkstyleExecutor, checkstyleRssGenerator, locator, PLUGIN_RESOURCES, project, siteTool, skip, stringOutputStream
 
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
CheckstyleAggregateReport()
           
 
Method Summary
 boolean canGenerateReport()
          
protected  CheckstyleExecutorRequest createRequest()
          Create the Checkstyle executor request.
 String getOutputName()
          
protected  MavenProject getProject()
          
 
Methods inherited from class org.apache.maven.plugin.checkstyle.AbstractCheckstyleReport
executeReport, getConsoleListener, getDescription, getListener, getName, getOutputDirectory, getSiteRenderer, setReportOutputDirectory
 
Methods inherited from class org.apache.maven.reporting.AbstractMavenReport
closeReport, execute, generate, generate, generate, getCategoryName, getReportOutputDirectory, getSink, getSinkFactory, isExternalReport
 
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
 

Constructor Detail

CheckstyleAggregateReport

public CheckstyleAggregateReport()
Method Detail

getProject

protected MavenProject getProject()

Overrides:
getProject in class AbstractCheckstyleReport

createRequest

protected CheckstyleExecutorRequest createRequest()
                                           throws MavenReportException
Create the Checkstyle executor request.

Specified by:
createRequest in class AbstractCheckstyleReport
Returns:
The executor request.
Throws:
MavenReportException - If something goes wrong during creation.

getOutputName

public String getOutputName()


canGenerateReport

public boolean canGenerateReport()

Specified by:
canGenerateReport in interface MavenReport
Overrides:
canGenerateReport in class AbstractMavenReport


Copyright © 2005-2012 The Apache Software Foundation. All Rights Reserved.