org.codehaus.mojo.javancss
Class NcssReportMojo

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

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

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

Author:
Jean-Laurent de Morlhon

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()
           
 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()
           
protected  java.io.File getSourceDirectory()
          Getter for the source directory
protected  java.lang.String getXmlOutputDirectory()
           
 
Methods inherited from class org.apache.maven.reporting.AbstractMavenReport
closeReport, execute, generate, getCategoryName, getReportOutputDirectory, getSink, 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

executeReport

public void executeReport(java.util.Locale locale)
                   throws org.apache.maven.reporting.MavenReportException
Throws:
org.apache.maven.reporting.MavenReportException
See Also:
org.apache.maven.reporting.MavenReport#execute(java.util.Locale)

canGenerateReport

public boolean canGenerateReport()
See Also:
MavenReport.canGenerateReport()

getName

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

getDescription

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

getOutputDirectory

protected java.lang.String getOutputDirectory()
See Also:
AbstractMavenReport.getOutputDirectory()

getXmlOutputDirectory

protected java.lang.String getXmlOutputDirectory()

getProject

protected org.apache.maven.project.MavenProject getProject()
See Also:
AbstractMavenReport.getProject()

getSiteRenderer

protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
See Also:
AbstractMavenReport.getSiteRenderer()

getOutputName

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

getSourceDirectory

protected java.io.File getSourceDirectory()
Getter for the source directory

Returns:
the source directory as a File object.


Copyright © 2005-2007 null. All Rights Reserved.