hudson.plugins.cppncss
Class CppNCSSGhostwriter

java.lang.Object
  hudson.plugins.cppncss.CppNCSSGhostwriter

All Implemented Interfaces:

Ghostwriter, Ghostwriter.MasterGhostwriter, Ghostwriter.SlaveGhostwriter, java.io.Serializable

public class CppNCSSGhostwriter
extends java.lang.Object
implements Ghostwriter, Ghostwriter.MasterGhostwriter, Ghostwriter.SlaveGhostwriter

TODO javadoc.

Since:

08-Jan-2008 23:16:52

Author:

Stephen Connolly

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.plugins.helpers.Ghostwriter

Ghostwriter.MasterGhostwriter, Ghostwriter.SlaveGhostwriter

Constructor Summary

CppNCSSGhostwriter(java.lang.String reportFilenamePattern, java.lang.Integer functionCcnViolationThreshold, java.lang.Integer functionNcssViolationThreshold, CppNCSSHealthTarget... targets)

Method Summary

boolean	performFromMaster(hudson.model.AbstractBuild<?,?> build, hudson.FilePath executionRoot, hudson.model.BuildListener listener) Runs (on the master) the step over the given build and reports the progress to the listener.
boolean	performFromSlave(BuildProxy build, hudson.model.BuildListener listener) Runs (on the slave) the step over the given build and reports the progress to the listener.

Methods inherited from class java.lang.Object

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

Constructor Detail

CppNCSSGhostwriter

public CppNCSSGhostwriter(java.lang.String reportFilenamePattern,
                          java.lang.Integer functionCcnViolationThreshold,
                          java.lang.Integer functionNcssViolationThreshold,
                          CppNCSSHealthTarget... targets)

Method Detail

performFromMaster

public boolean performFromMaster(hudson.model.AbstractBuild<?,?> build,
                                 hudson.FilePath executionRoot,
                                 hudson.model.BuildListener listener)
                          throws java.lang.InterruptedException,
                                 java.io.IOException

Description copied from interface: Ghostwriter.MasterGhostwriter

Runs (on the master) the step over the given build and reports the progress to the listener.

Specified by:

performFromMaster in interface Ghostwriter.MasterGhostwriter

Parameters:

build - The the build.

executionRoot - The module root on which the build executed.

listener - The buildListener.

Returns:

true if the build can continue, false if there was an error and the build needs to be aborted.

Throws:

java.lang.InterruptedException - If the build is interrupted by the user (in an attempt to abort the build.) Normally the BuildStep implementations may simply forward the exception it got from its lower-level functions.

java.io.IOException - If the implementation wants to abort the processing when an IOException happens, it can simply propagate the exception to the caller. This will cause the build to fail, with the default error message. Implementations are encouraged to catch IOException on its own to provide a better error message, if it can do so, so that users have better understanding on why it failed.

performFromSlave

public boolean performFromSlave(BuildProxy build,
                                hudson.model.BuildListener listener)
                         throws java.lang.InterruptedException,
                                java.io.IOException

Description copied from interface: Ghostwriter.SlaveGhostwriter

Runs (on the slave) the step over the given build and reports the progress to the listener.

Specified by:

performFromSlave in interface Ghostwriter.SlaveGhostwriter

Parameters:

build - The information about the build.

listener - The buildListener.

Returns:

true if the build can continue, false if there was an error and the build needs to be aborted.

Throws:

java.lang.InterruptedException - If the build is interrupted by the user (in an attempt to abort the build.) Normally the BuildStep implementations may simply forward the exception it got from its lower-level functions.

java.io.IOException - If the implementation wants to abort the processing when an IOException happens, it can simply propagate the exception to the caller. This will cause the build to fail, with the default error message. Implementations are encouraged to catch IOException on its own to provide a better error message, if it can do so, so that users have better understanding on why it failed.