hudson.plugins.violations
Class ViolationsCollector

java.lang.Object
  hudson.plugins.violations.ViolationsCollector

All Implemented Interfaces:

hudson.FilePath.FileCallable<ViolationsReport>, Serializable

public class ViolationsCollector
extends Object
implements hudson.FilePath.FileCallable<ViolationsReport>

Collects the violations xml files, analyses them, renders html reports to the working directory, and returns a summary Violations report.

See Also:

Serialized Form

Constructor Summary

ViolationsCollector(boolean mavenProject, hudson.FilePath targetDir, hudson.FilePath htmlDir, ViolationsConfig config)
Constructor.

Method Summary

ViolationsReport

invoke(File workspace, hudson.remoting.VirtualChannel channel) Create a report.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ViolationsCollector

public ViolationsCollector(boolean mavenProject,
                           hudson.FilePath targetDir,
                           hudson.FilePath htmlDir,
                           ViolationsConfig config)

Constructor.

Parameters:

mavenProject - true if this a maven project, false otherwise

targetDir - working directory to copy xml results to

htmlDir - working directory to html reports to.

config - the violations configuration.

Method Detail

invoke

public ViolationsReport invoke(File workspace,
                               hudson.remoting.VirtualChannel channel)
                        throws IOException

Create a report.

Specified by:

invoke in interface hudson.FilePath.FileCallable<ViolationsReport>

Parameters:

workspace - the current workspace.

channel - the virtual channel.

Returns:

the report.

Throws:

IOException - if there is a problem.