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.reporting.MavenReport, org.apache.maven.plugin.Mojo, org.codehaus.plexus.personality.plexus.lifecycle.phase.Serviceable

public class CheckstyleReport

extends org.apache.maven.reporting.AbstractMavenReport

implements org.codehaus.plexus.personality.plexus.lifecycle.phase.Serviceable

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

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 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.codehaus.doxia.site.renderer.SiteRenderer	getSiteRenderer()
void	service(org.codehaus.plexus.personality.plexus.lifecycle.phase.ServiceLocator locator) ${inheritDoc}
void	setReportOutputDirectory(java.io.File reportOutputDirectory)

Methods inherited from class org.apache.maven.reporting.AbstractMavenReport

closeReport, execute, generate, getCategoryName, getReportOutputDirectory, getSink, 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

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.

Constructor Detail

CheckstyleReport

public CheckstyleReport()

Method Detail

service

public void service(org.codehaus.plexus.personality.plexus.lifecycle.phase.ServiceLocator locator)

${inheritDoc}

Specified by:

service in interface org.codehaus.plexus.personality.plexus.lifecycle.phase.Serviceable

See Also:

Serviceable.service(org.codehaus.plexus.personality.plexus.lifecycle.phase.ServiceLocator)

getName

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

Specified by:

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

See Also:

MavenReport.getName(java.util.Locale)

getDescription

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

Specified by:

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

See Also:

MavenReport.getDescription(java.util.Locale)

getOutputDirectory

protected java.lang.String getOutputDirectory()

See Also:

AbstractMavenReport.getOutputDirectory()

getProject

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

See Also:

AbstractMavenReport.getProject()

getSiteRenderer

protected org.codehaus.doxia.site.renderer.SiteRenderer getSiteRenderer()

See Also:

AbstractMavenReport.getSiteRenderer()

executeReport

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

Throws:

org.apache.maven.reporting.MavenReportException

See Also:

AbstractMavenReport.executeReport(java.util.Locale)

getOutputName

public java.lang.String getOutputName()

Specified by:

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

See Also:

MavenReport.getOutputName()

canGenerateReport

public boolean canGenerateReport()

Specified by:

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

See Also:

AbstractMavenReport.canGenerateReport()

setReportOutputDirectory

public void setReportOutputDirectory(java.io.File reportOutputDirectory)

Specified by:

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

See Also:

AbstractMavenReport.setReportOutputDirectory(java.io.File)