cyvis.cli.ant
Class CyvisTask

java.lang.Object
  extended by org.apache.tools.ant.ProjectComponent
      extended by org.apache.tools.ant.Task
          extended by cyvis.cli.ant.CyvisTask

public class CyvisTask
extends org.apache.tools.ant.Task

Extends the org.apache.tools.ant.Task. Gets information from the ant file and performs the cyvis ant task. Uses the core.TUI class to process metrics and then generated reports.


Nested Class Summary
 class CyvisTask.Report
          A class to denote the nested element for the cyvis task.
 
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
CyvisTask()
           
 
Method Summary
 void addFileset(org.apache.tools.ant.types.FileSet set)
           
 CyvisTask.Report createReport()
           
 void execute()
          Overrides the execute method in the org.apache.tools.ant.Task class and performs the required actions required to generate reports.
 String getHome()
           
 void setHome(String home)
           
 void setVerbose(boolean verbose)
           
 
Methods inherited from class org.apache.tools.ant.Task
getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
 
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

CyvisTask

public CyvisTask()
Method Detail

execute

public void execute()
             throws org.apache.tools.ant.BuildException
Overrides the execute method in the org.apache.tools.ant.Task class and performs the required actions required to generate reports.

Overrides:
execute in class org.apache.tools.ant.Task
Throws:
org.apache.tools.ant.BuildException

setVerbose

public void setVerbose(boolean verbose)
Parameters:
verbose - indicates verbose on and off

addFileset

public void addFileset(org.apache.tools.ant.types.FileSet set)
Parameters:
set - fileset given in the ant build file.

getHome

public String getHome()
Returns:
the cyvis-home dir

setHome

public void setHome(String home)
Parameters:
home - cyvis home directory

createReport

public CyvisTask.Report createReport()
Returns:
an report object.