Package com.parasoft.findings.jenkins.coverage.api.metrics.source

Class SourceCodePainter

java.lang.Object

com.parasoft.findings.jenkins.coverage.api.metrics.source.SourceCodePainter

public class SourceCodePainter
extends Object

Highlights the code coverage information in all source code files. This process is executed on the agent node that has all source files checked out.

Constructor Summary

Constructors

Constructor	Description
SourceCodePainter(Run<?,?> build, FilePath workspace, String id)	Creates a painter for the passed build, using the passed properties.

Method Summary

Modifier and Type	Method	Description
void	processSourceCodePainting(Node rootNode, List<FileNode> files, String sourceCodeEncoding, io.jenkins.plugins.prism.SourceCodeRetention sourceCodeRetention, edu.hm.hafner.util.FilteredLog log)	Processes the source code painting.

Methods inherited from class java.lang.Object

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

Constructor Detail

SourceCodePainter

public SourceCodePainter(@NonNull
                         Run<?,?> build,
                         @NonNull
                         FilePath workspace,
                         String id)

Creates a painter for the passed build, using the passed properties.

Parameters:

build - The build which processes the source code

workspace - The workspace which contains the source code files

id - the ID of the coverage results - each ID will store the files in a separate directory

Method Detail

processSourceCodePainting

public void processSourceCodePainting(Node rootNode,
                                      List<FileNode> files,
                                      String sourceCodeEncoding,
                                      io.jenkins.plugins.prism.SourceCodeRetention sourceCodeRetention,
                                      edu.hm.hafner.util.FilteredLog log)
                               throws InterruptedException

Processes the source code painting.

Parameters:

rootNode - the root of the tree

files - the files to paint

sourceCodeEncoding - the encoding of the source code files

sourceCodeRetention - the source code retention strategy

log - The log

Throws:

InterruptedException - if the painting process has been interrupted