net.sf.statcvs.ant
Class StatCvsTask

java.lang.Object
  |
  +--org.apache.tools.ant.ProjectComponent
        |
        +--org.apache.tools.ant.Task
              |
              +--net.sf.statcvs.ant.StatCvsTask

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
description, location, target, taskName, taskType, wrapper
 
Fields inherited from class org.apache.tools.ant.ProjectComponent
project
 
Constructor Summary
StatCvsTask()
          Constructor for StatCvsTask.
 
Method Summary
 void execute()
          Runs the task
 void setChoraURL(java.lang.String chora)
           
 void setCssFile(java.lang.String cssFile)
           
 void setCvsLogFile(java.lang.String logFile)
           
 void setCvswebURL(java.lang.String cvsweb)
           
 void setExcludeFiles(java.lang.String exclude)
          Specifies files to exclude from the analysis.
 void setIncludeFiles(java.lang.String include)
          Specifies files to include in the analysis.
 void setNotesFile(java.lang.String notesFile)
           
 void setOutputDirectory(java.lang.String outDir)
           
 void setProjectDirectory(java.lang.String modDir)
           
 void setShowCredits(boolean showCredits)
           
 void setTitle(java.lang.String title)
           
 void setViewcvsURL(java.lang.String viewcvs)
           
 
Methods inherited from class org.apache.tools.ant.Task
getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, handleErrorFlush, handleErrorOutput, handleFlush, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName
 
Methods inherited from class org.apache.tools.ant.ProjectComponent
getProject, setProject
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StatCvsTask

public StatCvsTask()
Constructor for StatCvsTask.

Method Detail

execute

public void execute()
             throws org.apache.tools.ant.BuildException
Runs the task

Overrides:
execute in class org.apache.tools.ant.Task
Throws:
org.apache.tools.ant.BuildException - if an IO Error occurs

setTitle

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

setCvsLogFile

public void setCvsLogFile(java.lang.String logFile)
Parameters:
logFile - String representing the cvs log file

setProjectDirectory

public void setProjectDirectory(java.lang.String modDir)
Parameters:
modDir - String representing the directory containing the CVS project

setOutputDirectory

public void setOutputDirectory(java.lang.String outDir)
Parameters:
outDir - String representing the output directory of the report

setCssFile

public void setCssFile(java.lang.String cssFile)
Parameters:
cssFile - String representing the CSS file to use for the report

setNotesFile

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

setShowCredits

public void setShowCredits(boolean showCredits)
Parameters:
showCredits - Show credit information in report?

setViewcvsURL

public void setViewcvsURL(java.lang.String viewcvs)
Parameters:
viewcvs - String representing the URL of a ViewCVS installation

setCvswebURL

public void setCvswebURL(java.lang.String cvsweb)
Parameters:
cvsweb - String representing the URL of a cvsweb installation

setChoraURL

public void setChoraURL(java.lang.String chora)
Parameters:
chora - String representing the URL of a Chora installation

setIncludeFiles

public void setIncludeFiles(java.lang.String include)
Specifies files to include in the analysis.

Parameters:
include - a list of Ant-style wildcard patterns, delimited by : or ;
See Also:
FilePatternMatcher

setExcludeFiles

public void setExcludeFiles(java.lang.String exclude)
Specifies files to exclude from the analysis.

Parameters:
exclude - a list of Ant-style wildcard patterns, delimited by : or ;
See Also:
FilePatternMatcher