cppncss
Class CppNcssTask

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          org.apache.tools.ant.taskdefs.AntlibDefinition
              cppncss.CppNcssTask

All Implemented Interfaces:

java.lang.Cloneable

public final class CppNcssTask
extends org.apache.tools.ant.taskdefs.AntlibDefinition

Provides an Apache Ant task implementation for CppNcss.

Author:

Mathieu Champlon

Nested Class Summary

static class	CppNcssTask.Define Provides a define definition.
static class	CppNcssTask.Macro Provides a macro definition.
static class	CppNcssTask.Symbol Provides a symbol definition.

Field Summary

Fields inherited from class org.apache.tools.ant.Task

target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Constructor Summary

CppNcssTask()

Method Summary

void	addConfiguredDefine(CppNcssTask.Define define) Add a define definition.
void	addConfiguredMacro(CppNcssTask.Macro macro) Add a macro definition.
void	addFileset(org.apache.tools.ant.types.FileSet fileset) Add a set of source files.
void	execute()
void	setKeepGoing(boolean keepGoing) Set whether the analyzis should stop upon error or not.
void	setMeasurements(java.lang.String measurements) Set the measurements.
void	setPrefix(java.lang.String prefix) Define a prefix.
void	setSamples(int samples) Set the number of samples to output.
void	setToFile(java.lang.String filename) Set the name of the output file.

Methods inherited from class org.apache.tools.ant.taskdefs.AntlibDefinition

getAntlibClassLoader, getURI, setAntlibClassLoader, setURI

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object

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

Constructor Detail

CppNcssTask

public CppNcssTask()

Method Detail

addFileset

public void addFileset(org.apache.tools.ant.types.FileSet fileset)

Add a set of source files.

Parameters:

fileset - a set of source files.

setPrefix

public void setPrefix(java.lang.String prefix)

Define a prefix.

Not required.

Parameters:

prefix - the prefix

setToFile

public void setToFile(java.lang.String filename)

Set the name of the output file.

Required.

Parameters:

filename - the file name

setKeepGoing

public void setKeepGoing(boolean keepGoing)

Set whether the analyzis should stop upon error or not.

Not required. Default is false.

Parameters:

keepGoing - if the analyzis should keep going upon error

setSamples

public void setSamples(int samples)

Set the number of samples to output.

Not required. Default is all.

Parameters:

samples - truncate the output after this given number of samples

setMeasurements

public void setMeasurements(java.lang.String measurements)

Set the measurements.

Not required. Default is "NCSS,CCN,function".

Parameters:

measurements - the ordered list of measurements to perform

addConfiguredDefine

public void addConfiguredDefine(CppNcssTask.Define define)

Add a define definition.

Parameters:

define - the define

addConfiguredMacro

public void addConfiguredMacro(CppNcssTask.Macro macro)

Add a macro definition.

Parameters:

macro - the macro

execute

public void execute()

Overrides:

execute in class org.apache.tools.ant.Task