org.codehaus.mojo.javancss

Class NcssExecuter

java.lang.Object

org.codehaus.mojo.javancss.NcssExecuter

public class NcssExecuter
extends Object

The NcssExecuter is able to call JavaNCSS to produce a code analysis.
The results are produced into a raw xml file.

Version:

$Id$

Author:

Jean-Laurent de Morlhon

Constructor Summary

Constructors

Constructor and Description
NcssExecuter(File sourceDirectory, String outputFilename) Construct a NcssExecuter.
NcssExecuter(String[] fileList, String outputFilename)

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() Call the JavaNCSS code analysis tool to produce the result to a temporary file.
String	getEncoding()
static String	getJavaNCSSVersion()
void	setEncoding(String encoding)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NcssExecuter

public NcssExecuter(File sourceDirectory,
            String outputFilename)

Construct a NcssExecuter.

Parameters:

sourceDirectory - the directory where the source to analyze are.

outputFilename - the output file where the result will be written.

NcssExecuter

public NcssExecuter(String[] fileList,
            String outputFilename)

Method Detail

setEncoding

public void setEncoding(String encoding)

getEncoding

public String getEncoding()

execute

public void execute()
             throws org.apache.maven.reporting.MavenReportException

Call the JavaNCSS code analysis tool to produce the result to a temporary file.

Throws:

org.apache.maven.reporting.MavenReportException - if something goes bad during the execution

getJavaNCSSVersion

public static String getJavaNCSSVersion()