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.CheckstyleReport
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenReport

public class CheckstyleReport
extends org.apache.maven.reporting.AbstractMavenReport

Perform a Checkstyle analysis, and generate a report on violations.

Version:
$Id: CheckstyleReport.java 890543 2009-12-14 23:09:43Z olamy $
Author:
Emmanuel Venisse, Vincent Siveton, Joakim Erdfelt

Field Summary
protected  CheckstyleExecutor checkstyleExecutor
           
protected  CheckstyleRssGenerator checkstyleRssGenerator
          CheckstyleRssGenerator.
static java.lang.String PLUGIN_RESOURCES
           
protected  org.apache.maven.doxia.tools.SiteTool siteTool
          SiteTool.
 
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()
          
 void executeReport(java.util.Locale locale)
          
 java.lang.String getDescription(java.util.Locale locale)
          
 java.lang.String getName(java.util.Locale locale)
          
protected  java.lang.String getOutputDirectory()
          
 java.lang.String getOutputName()
          
protected  org.apache.maven.project.MavenProject getProject()
          
protected  org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
          
 void setReportOutputDirectory(java.io.File reportOutputDirectory)
          
 
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
 

Field Detail

PLUGIN_RESOURCES

public static final java.lang.String PLUGIN_RESOURCES
See Also:
Constant Field Values

siteTool

protected org.apache.maven.doxia.tools.SiteTool siteTool
SiteTool.

Since:
2.2

checkstyleRssGenerator

protected CheckstyleRssGenerator checkstyleRssGenerator
CheckstyleRssGenerator.

Since:
2.4

checkstyleExecutor

protected CheckstyleExecutor checkstyleExecutor
Since:
2.5
Constructor Detail

CheckstyleReport

public CheckstyleReport()
Method Detail

getName

public java.lang.String getName(java.util.Locale locale)


getDescription

public java.lang.String getDescription(java.util.Locale locale)


getOutputDirectory

protected java.lang.String getOutputDirectory()

Specified by:
getOutputDirectory in class org.apache.maven.reporting.AbstractMavenReport

getProject

protected org.apache.maven.project.MavenProject getProject()

Specified by:
getProject in class org.apache.maven.reporting.AbstractMavenReport

getSiteRenderer

protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()

Specified by:
getSiteRenderer in class org.apache.maven.reporting.AbstractMavenReport

executeReport

public void executeReport(java.util.Locale locale)
                   throws org.apache.maven.reporting.MavenReportException

Specified by:
executeReport in class org.apache.maven.reporting.AbstractMavenReport
Throws:
org.apache.maven.reporting.MavenReportException

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

setReportOutputDirectory

public void setReportOutputDirectory(java.io.File reportOutputDirectory)

Specified by:
setReportOutputDirectory in interface org.apache.maven.reporting.MavenReport
Overrides:
setReportOutputDirectory in class org.apache.maven.reporting.AbstractMavenReport


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