net.objectlab.qalab.ant
Class BuildStatMergeTask

java.lang.Object
  extended by Task
      extended by net.objectlab.qalab.ant.BuildStatMergeTask

public class BuildStatMergeTask
extends Task

The ant task that handles the merger of statistics into qalab.xml.

Version:
$Revision: 187 $
Author:
Benoit Xhenseval

Constructor Summary
BuildStatMergeTask()
           
 
Method Summary
 void execute()
          Method invoked by the ant framework to execute the action associated with this task.
 java.lang.String getExporterClassName()
           
 void setExporterClassName(java.lang.String exporterClass)
           
 void setHandler(java.lang.String theHandler)
          Sets the class name for the handler for the given statistics.
 void setInputFile(java.io.File newStatisticsFile)
          Sets the input file containing the new statistics (checkstyle,etc).
 void setMergerTimeStamp(java.lang.String timestamp)
          Sets the timestamp mode.
 void setOutputFile(java.io.File consolidatedFile)
          Set the to output file (typically qalab.xml).
 void setPropertiesFile(java.io.File aProps)
          Sets a properties file for use instead of individually setting them.
 void setQuiet(boolean noLog)
          Sets the quiet mode.
 void setSrcDir(java.lang.String sourceDirectory)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BuildStatMergeTask

public BuildStatMergeTask()
Method Detail

setHandler

public final void setHandler(java.lang.String theHandler)
Sets the class name for the handler for the given statistics.

Parameters:
theHandler - class name for the handler.

setSrcDir

public final void setSrcDir(java.lang.String sourceDirectory)
Parameters:
sourceDirectory - directory where the source code is.

setInputFile

public final void setInputFile(java.io.File newStatisticsFile)
Sets the input file containing the new statistics (checkstyle,etc).

Parameters:
newStatisticsFile - the whose values will be incorporated in the qalab.xml

setOutputFile

public final void setOutputFile(java.io.File consolidatedFile)
Set the to output file (typically qalab.xml).

Parameters:
consolidatedFile - the destination file where the statistics are written. The file may or may not exists.

setQuiet

public final void setQuiet(boolean noLog)
Sets the quiet mode.

Parameters:
noLog - if true, no messages are displayed while merging stats.

setMergerTimeStamp

public final void setMergerTimeStamp(java.lang.String timestamp)
Sets the timestamp mode.

Parameters:
timestamp - if present, uses this as timestamp for stats.

execute

public final void execute()
Method invoked by the ant framework to execute the action associated with this task. This will validate the input parameters then merge the statistics.


setExporterClassName

public final void setExporterClassName(java.lang.String exporterClass)
Parameters:
exporterClass - The exporterClassName to set.

getExporterClassName

public final java.lang.String getExporterClassName()
Returns:
Returns the exporterClassName.

setPropertiesFile

public final void setPropertiesFile(java.io.File aProps)
Sets a properties file for use instead of individually setting them.

Parameters:
aProps - the properties File to use