net.sf.statcvs.ant

Class StatCvsTask


public class StatCvsTask
extends Task

Ant task for running statcvs.
Authors:
Andy Glover
Richard Cyganiak

Constructor Summary

StatCvsTask()
Constructor for StatCvsTask.

Method Summary

void
execute()
Runs the task
protected void
initProperties()
method initializes the ConfigurationOptions object with received values.
void
setBugzilla(String bugzilla)
void
setChora(String chora)
void
setCss(String cssFile)
void
setCvsweb(String cvsweb)
void
setExclude(String exclude)
Specifies files to exclude from the analysis.
void
setFormat(String format)
void
setInclude(String include)
Specifies files to include in the analysis.
void
setJCVSWeb(String jcvsweb)
void
setLog(String logFile)
void
setMantis(String mantis)
void
setNoDeveloper(String nonDeveloperLogin)
TODO: This supports just a single value, but should support multiple login names -- how?
void
setNotes(String notesFile)
void
setOutputDir(String outDir)
void
setPath(String modDir)
void
setTags(String tags)
Specifies regular expression to include tag to lines of code graph.
void
setTitle(String title)
void
setViewCVS(String viewcvs)
void
setViewVC(String viewvc)
void
setXDoc(boolean generateXDoc)

Constructor Details

StatCvsTask

public StatCvsTask()
Constructor for StatCvsTask.

Method Details

execute

public void execute()
            throws BuildException
Runs the task

initProperties

protected void initProperties()
            throws ConfigurationException
method initializes the ConfigurationOptions object with received values.

setBugzilla

public void setBugzilla(String bugzilla)
Parameters:
bugzilla - String representing the URL of a Bugzilla installation

setChora

public void setChora(String chora)
Parameters:
chora - String representing the URL of a Chora installation

setCss

public void setCss(String cssFile)
Parameters:
cssFile - String representing the CSS file to use for the report

setCvsweb

public void setCvsweb(String cvsweb)
Parameters:
cvsweb - String representing the URL of a cvsweb installation

setExclude

public void setExclude(String exclude)
Specifies files to exclude from the analysis.
Parameters:
exclude - a list of Ant-style wildcard patterns, delimited by : or ;

setFormat

public void setFormat(String format)
Parameters:
format - "xdoc" or "html"

setInclude

public void setInclude(String include)
Specifies files to include in the analysis.
Parameters:
include - a list of Ant-style wildcard patterns, delimited by : or ;

setJCVSWeb

public void setJCVSWeb(String jcvsweb)
Parameters:
jcvsweb - String representing the URL of a JCVSWeb installation

setLog

public void setLog(String logFile)
Parameters:
logFile - String representing the cvs log file

setMantis

public void setMantis(String mantis)
Parameters:
mantis - String representing the URL of a Mantis installation

setNoDeveloper

public void setNoDeveloper(String nonDeveloperLogin)
TODO: This supports just a single value, but should support multiple login names -- how?
Parameters:
nonDeveloperLogin - A login name to be excluded from developer lists

setNotes

public void setNotes(String notesFile)
Parameters:
notesFile - String representing the notes file to include on the report's index page

setOutputDir

public void setOutputDir(String outDir)
Parameters:
outDir - String representing the output directory of the report

setPath

public void setPath(String modDir)
Parameters:
modDir - String representing the directory containing the CVS project

setTags

public void setTags(String tags)
Specifies regular expression to include tag to lines of code graph.
Parameters:
tags - regular expression to included tags names.

setTitle

public void setTitle(String title)
Parameters:
title - String representing the title to be used in the reports

setViewCVS

public void setViewCVS(String viewcvs)
Parameters:
viewcvs - String representing the URL of a ViewCVS installation

setViewVC

public void setViewVC(String viewvc)
Parameters:
viewvc - String representing the URL of a ViewVC installation

setXDoc

public void setXDoc(boolean generateXDoc)
Parameters:
generateXDoc - Generate XDoc or HTML?