org.apache.maven.plugin.checkstyle
Class CheckstyleReport

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.CheckstyleReport
All Implemented Interfaces:
ContextEnabled, Mojo, MavenMultiPageReport, MavenReport

@Mojo(name="checkstyle",
      requiresDependencyResolution=COMPILE,
      threadSafe=true)
public class CheckstyleReport
extends AbstractCheckstyleReport

A reporting task that performs Checkstyle analysis and generates an HTML report on any violations that Checkstyle finds.

Version:
$Id: CheckstyleReport.java 1652857 2015-01-18 21:40:14Z hboutemy $
Author:
Emmanuel Venisse, Vincent Siveton, Joakim Erdfelt

Field Summary
 
Fields inherited from class org.apache.maven.plugin.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
CheckstyleReport()
           
 
Method Summary
 boolean canGenerateReport()
          
protected  CheckstyleExecutorRequest createRequest()
          Create the Checkstyle executor request.
 void executeReport(Locale locale)
          
 String getOutputName()
          
protected  MavenProject getProject()
          
 
Methods inherited from class org.apache.maven.plugin.checkstyle.AbstractCheckstyleReport
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
 

Constructor Detail

CheckstyleReport

public CheckstyleReport()
Method Detail

getProject

protected MavenProject getProject()

Overrides:
getProject in class AbstractMavenReport

executeReport

public void executeReport(Locale locale)
                   throws MavenReportException

Overrides:
executeReport in class AbstractCheckstyleReport
Throws:
MavenReportException

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–2015 The Apache Software Foundation. All rights reserved.