Package net.sf.statcvs.ant
Class StatCvsTask
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
net.sf.statcvs.ant.StatCvsTask
- All Implemented Interfaces:
Cloneable
public class StatCvsTask
extends org.apache.tools.ant.Task
Ant task for running statcvs.
- Author:
- Andy Glover, Richard Cyganiak
-
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
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
execute()
Runs the taskprotected void
method initializes the ConfigurationOptions object with received values.void
setBugzilla
(String bugzilla) void
setCharset
(String charset) void
void
setConfigFile
(String configFile) void
void
void
setDisableTwitterButton
(boolean disableTwitterButton) void
setExclude
(String exclude) Specifies files to exclude from the analysis.void
void
setInclude
(String include) Specifies files to include in the analysis.void
setJCVSWeb
(String jcvsweb) void
void
void
setNoDeveloper
(String nonDeveloperLogin) TODO: This supports just a single value, but should support multiple login names -- how?void
void
setOutputDir
(String outDir) void
void
Specifies regular expression to include tag to lines of code graph.void
void
setViewCVS
(String viewcvs) void
void
setXDoc
(boolean generateXDoc) 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
-
Constructor Details
-
StatCvsTask
public StatCvsTask()Constructor for StatCvsTask.
-
-
Method Details
-
execute
public void execute() throws org.apache.tools.ant.BuildExceptionRuns the task- Overrides:
execute
in classorg.apache.tools.ant.Task
- Throws:
org.apache.tools.ant.BuildException
- if an IO Error occurs
-
initProperties
method initializes the ConfigurationOptions object with received values.- Throws:
ConfigurationException
-
setLog
- Parameters:
logFile
- String representing the cvs log file
-
setPath
- Parameters:
modDir
- String representing the directory containing the CVS project
-
setOutputDir
- Parameters:
outDir
- String representing the output directory of the report
-
setInclude
Specifies files to include in the analysis.- Parameters:
include
- a list of Ant-style wildcard patterns, delimited by : or ;- See Also:
-
setExclude
Specifies files to exclude from the analysis.- Parameters:
exclude
- a list of Ant-style wildcard patterns, delimited by : or ;- See Also:
-
setTags
Specifies regular expression to include tag to lines of code graph.- Parameters:
tags
- regular expression to included tags names.
-
setTitle
- Parameters:
title
- String representing the title to be used in the reports
-
setCss
- Parameters:
cssFile
- String representing the CSS file to use for the report
-
setNotes
- Parameters:
notesFile
- String representing the notes file to include on the report's index page
-
setViewCVS
- Parameters:
viewcvs
- String representing the URL of a ViewCVS installation
-
setViewVC
- Parameters:
viewvc
- String representing the URL of a ViewVC installation
-
setCvsweb
- Parameters:
cvsweb
- String representing the URL of a cvsweb installation
-
setChora
- Parameters:
chora
- String representing the URL of a Chora installation
-
setJCVSWeb
- Parameters:
jcvsweb
- String representing the URL of a JCVSWeb installation
-
setBugzilla
- Parameters:
bugzilla
- String representing the URL of a Bugzilla installation
-
setMantis
- Parameters:
mantis
- String representing the URL of a Mantis installation
-
setXDoc
public void setXDoc(boolean generateXDoc) - Parameters:
generateXDoc
- Generate XDoc or HTML?
-
setFormat
- Parameters:
format
- "xdoc" or "html"
-
setNoDeveloper
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
-
setCharset
-
setConfigFile
-
setDisableTwitterButton
public void setDisableTwitterButton(boolean disableTwitterButton)
-