org.hackystat.sensor.ant.checkstyle
Class CheckstyleSensor

java.lang.Object
  extended by org.apache.tools.ant.ProjectComponent
      extended by org.apache.tools.ant.Task
          extended by org.hackystat.sensor.ant.task.HackystatSensorTask
              extended by org.hackystat.sensor.ant.checkstyle.CheckstyleSensor
All Implemented Interfaces:
java.lang.Cloneable

public class CheckstyleSensor
extends HackystatSensorTask

Implements an Ant task that parses the XML files generated by Checkstyle. The Ant Task sends the CodeIssue data to a Hackystat server.

Author:
Julie Ann Sakuda, Philip Johnson

Field Summary
 
Fields inherited from class org.hackystat.sensor.ant.task.HackystatSensorTask
dataFilesList, errMsgPrefix, failOnError, msgPrefix, runtime, sensorProps, sensorShell, sourceFilesList, toolAccount, tstampSet, verbose
 
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
CheckstyleSensor()
          Initialize a new instance of a CheckstyleSensor.
CheckstyleSensor(java.lang.String host, java.lang.String email, java.lang.String password)
          Initialize a new instance of a CheckstyleSensor for testing purposes.
 
Method Summary
 void executeInternal()
          Parses the Checkstyle XML files and sends the resulting code issue results to the SensorBase server.
 int processIssueXmlFile(java.io.File xmlFile)
          Parses a Checkstyle XML file and sends the code issue instances to the shell.
 
Methods inherited from class org.hackystat.sensor.ant.task.HackystatSensorTask
createDataFiles, createSourceFiles, execute, getDataFiles, getFiles, getSourceFiles, info, isUsingUserMap, sendAndQuit, setFailOnError, setRetryAttempts, setRetryWaitInterval, setupSensorShell, setUserMapTool, setUserMapToolAccount, setVerbose, signalError, summaryInfo, verboseInfo
 
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
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CheckstyleSensor

public CheckstyleSensor()
Initialize a new instance of a CheckstyleSensor.


CheckstyleSensor

public CheckstyleSensor(java.lang.String host,
                        java.lang.String email,
                        java.lang.String password)
Initialize a new instance of a CheckstyleSensor for testing purposes.

Parameters:
host - The SensorBase host URL.
email - The SensorBase email to use.
password - The SensorBase password to use.
Method Detail

executeInternal

public void executeInternal()
                     throws org.apache.tools.ant.BuildException
Parses the Checkstyle XML files and sends the resulting code issue results to the SensorBase server.

Specified by:
executeInternal in class HackystatSensorTask
Throws:
org.apache.tools.ant.BuildException - If there is an error.

processIssueXmlFile

public int processIssueXmlFile(java.io.File xmlFile)
                        throws org.apache.tools.ant.BuildException
Parses a Checkstyle XML file and sends the code issue instances to the shell.

Parameters:
xmlFile - The XML file name to be processed.
Returns:
The number of issues that have been processed in this XML file.
Throws:
org.apache.tools.ant.BuildException - thrown if it fails to process a file.