org.codehaus.mojo.javancss

Class NcssReportMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

org.codehaus.mojo.javancss.NcssReportMojo

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="report")
public class NcssReportMojo
extends org.apache.maven.reporting.AbstractMavenReport

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

Version:

$Id$

Author:

Jean-Laurent de Morlhon

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 and Description
NcssReportMojo()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canGenerateReport()
protected String	constructXRefLocation()
void	executeReport(Locale locale)
String	getDescription(Locale locale)
String	getName(Locale locale)
String	getOutputName()
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, 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

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)

getXmlOutputDirectory

protected String getXmlOutputDirectory()

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()