org.apache.maven.plugin.checkstyle
Class CheckstyleReport

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.reporting.AbstractMavenReport
          org.apache.maven.plugin.checkstyle.CheckstyleReport

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenMultiPageReport, 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.html 816663 2012-05-08 14:00:13Z hboutemy $

Author:

Emmanuel Venisse, Vincent Siveton, Joakim Erdfelt

Is defined by the goal name:

checkstyle

Requires the dependencies in this specified scope:

compile

Field Summary

protected CheckstyleExecutor	checkstyleExecutor
protected CheckstyleRssGenerator	checkstyleRssGenerator CheckstyleRssGenerator.
static 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(Locale locale)
String	getDescription(Locale locale)
String	getName(Locale locale)
protected String	getOutputDirectory()
String	getOutputName()
protected org.apache.maven.project.MavenProject	getProject()
protected org.apache.maven.doxia.siterenderer.Renderer	getSiteRenderer()
void	setReportOutputDirectory(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 String PLUGIN_RESOURCES

See Also:

Constant Field Values

siteTool

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

SiteTool.

Since:

2.2

Is a Plexus component defined by:

role:

org.apache.maven.doxia.tools.SiteTool

Is readonly.

Is required.

checkstyleRssGenerator

protected CheckstyleRssGenerator checkstyleRssGenerator

CheckstyleRssGenerator.

Since:

2.4

Is a Plexus component defined by:

role:

org.apache.maven.plugin.checkstyle.rss.CheckstyleRssGenerator

role-hint:

default

Is readonly.

Is required.

checkstyleExecutor

protected CheckstyleExecutor checkstyleExecutor

Since:

2.5

Is a Plexus component defined by:

role:

org.apache.maven.plugin.checkstyle.CheckstyleExecutor

role-hint:

default

Is readonly.

Is required.

Constructor Detail

CheckstyleReport

public CheckstyleReport()

Method Detail

getName

public String getName(Locale locale)

getDescription

public String getDescription(Locale locale)

getOutputDirectory

protected 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(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 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(File reportOutputDirectory)

Specified by:

setReportOutputDirectory in interface org.apache.maven.reporting.MavenReport

Overrides:

setReportOutputDirectory in class org.apache.maven.reporting.AbstractMavenReport