CodeNarcReportMojo (CodeNarc Maven Plugin 0.1 API)

java.lang.Object
- org.apache.maven.plugin.AbstractMojo
- - org.apache.maven.reporting.AbstractMavenReport
  - - io.github.crizzis.codenarc.CodeNarcReportMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenMultiPageReport, org.apache.maven.reporting.MavenReport
```
@Mojo(name="codenarc",
      defaultPhase=SITE)
@Execute(goal="verify")
public class CodeNarcReportMojo
extends org.apache.maven.reporting.AbstractMavenReport
```
Create a CodeNarc report (implies the execution of the verify goal)

Field Summary
- 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

Constructors
Constructor Description

CodeNarcReportMojo(CodeNarcXmlParser xmlParser, CodeNarcReportGenerator reportGenerator)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`canGenerateReport()`
`protected void`	`executeReport(Locale locale)`
`String`	`getDescription(Locale locale)`
`String`	`getName(Locale locale)`
`String`	`getOutputName()`

Methods inherited from class org.apache.maven.reporting.AbstractMavenReport
closeReport, execute, generate, generate, generate, getCategoryName, getInputEncoding, getOutputDirectory, getOutputEncoding, getProject, 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

CodeNarcReportMojo

@Inject
public CodeNarcReportMojo(CodeNarcXmlParser xmlParser,
                          CodeNarcReportGenerator reportGenerator)

Method Detail
- canGenerateReport
```
public boolean canGenerateReport()
```
  Specified by:
  
  canGenerateReport in interface org.apache.maven.reporting.MavenReport
  
  Overrides:
  
  canGenerateReport in class org.apache.maven.reporting.AbstractMavenReport
- executeReport
```
protected 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()
```
- getName
```
public String getName(Locale locale)
```
- getDescription
```
public String getDescription(Locale locale)
```