org.codehaus.mojo.javancss
Class NcssReportMojo

java.lang.Object
  extended by org.apache.maven.plugin.AbstractMojo
      extended by org.apache.maven.reporting.AbstractMavenReport
          extended by org.codehaus.mojo.javancss.NcssReportMojo
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenReport

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

Generates a JavaNCSS report based on this module's source code.

Version:
$Id: NcssReportMojo.java 9906 2009-06-02 15:04:27Z jeanlaurent $
Author:
Jean-Laurent de Morlhon
Is defined by the goal name:
report

Field Summary
 
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
NcssReportMojo()
           
 
Method Summary
 boolean canGenerateReport()
           
protected  String constructXRefLocation()
           
 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()
           
protected  File getSourceDirectory()
          Getter for the source directory
protected  String getSourceEncoding()
          Gets the source files encoding.
protected  String getXmlOutputDirectory()
           
 
Methods inherited from class org.apache.maven.reporting.AbstractMavenReport
closeReport, execute, generate, generate, generate, getCategoryName, getReportOutputDirectory, getSink, getSinkFactory, 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

NcssReportMojo

public NcssReportMojo()
Method Detail

getSourceEncoding

protected String getSourceEncoding()
Gets the source files encoding.

Returns:
The source file encoding.

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
See Also:
org.apache.maven.reporting.MavenReport#executeReport(java.util.Locale)

canGenerateReport

public boolean canGenerateReport()
Specified by:
canGenerateReport in interface org.apache.maven.reporting.MavenReport
Overrides:
canGenerateReport in class org.apache.maven.reporting.AbstractMavenReport
See Also:
MavenReport.canGenerateReport()

getName

public String getName(Locale locale)
See Also:
MavenReport.getName(java.util.Locale)

getDescription

public String getDescription(Locale locale)
See Also:
MavenReport.getDescription(java.util.Locale)

getOutputDirectory

protected String getOutputDirectory()
Specified by:
getOutputDirectory in class org.apache.maven.reporting.AbstractMavenReport
See Also:
AbstractMavenReport.getOutputDirectory()

getXmlOutputDirectory

protected String getXmlOutputDirectory()

getProject

protected org.apache.maven.project.MavenProject getProject()
Specified by:
getProject in class org.apache.maven.reporting.AbstractMavenReport
See Also:
AbstractMavenReport.getProject()

getSiteRenderer

protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
Specified by:
getSiteRenderer in class org.apache.maven.reporting.AbstractMavenReport
See Also:
AbstractMavenReport.getSiteRenderer()

getOutputName

public String getOutputName()
See Also:
MavenReport.getOutputName()

getSourceDirectory

protected File getSourceDirectory()
Getter for the source directory

Returns:
the source directory as a File object.

constructXRefLocation

protected String constructXRefLocation()


Copyright © 2005-2011 Codehaus. All Rights Reserved.