Package io.jenkins.plugins.analysis.core.model

Class IssueReportScanner

java.lang.Object

jenkins.MasterToSlaveFileCallable<io.jenkins.plugins.util.AgentFileVisitor.FileVisitorResult<T>>

io.jenkins.plugins.util.AgentFileVisitor<edu.hm.hafner.analysis.Report>

io.jenkins.plugins.analysis.core.model.IssueReportScanner

All Implemented Interfaces:

FilePath.FileCallable<io.jenkins.plugins.util.AgentFileVisitor.FileVisitorResult<edu.hm.hafner.analysis.Report>>, Serializable, ControllerToAgentFileCallable<io.jenkins.plugins.util.AgentFileVisitor.FileVisitorResult<edu.hm.hafner.analysis.Report>>, org.jenkinsci.remoting.RoleSensitive

public class IssueReportScanner
extends io.jenkins.plugins.util.AgentFileVisitor<edu.hm.hafner.analysis.Report>

Scans the workspace for issues reports that match a specified Ant file pattern and parse these files with the specified parser. Creates a new Report for each parsed file. For files that cannot be read, an empty report will be returned.

Author:

Ullrich Hafner

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class io.jenkins.plugins.util.AgentFileVisitor

io.jenkins.plugins.util.AgentFileVisitor.FileVisitorResult<T extends Serializable>

Constructor Summary

Constructors

Constructor	Description
IssueReportScanner(String filePattern, String encoding, boolean followSymbolicLinks, edu.hm.hafner.analysis.IssueParser parser, boolean errorOnEmptyFiles)	Creates a new instance of IssueReportScanner.

Method Summary

Modifier and Type	Method	Description
protected Optional<edu.hm.hafner.analysis.Report>	processFile(Path file, Charset charset, edu.hm.hafner.util.FilteredLog log)

Methods inherited from class io.jenkins.plugins.util.AgentFileVisitor

invoke, plural

Methods inherited from class java.lang.Object

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

Methods inherited from interface jenkins.agents.ControllerToAgentFileCallable

checkRoles

Constructor Details

IssueReportScanner

public IssueReportScanner(String filePattern,
 String encoding,
 boolean followSymbolicLinks,
 edu.hm.hafner.analysis.IssueParser parser,
 boolean errorOnEmptyFiles)

Creates a new instance of IssueReportScanner.

Parameters:

filePattern - ant file-set pattern to scan for files to parse

encoding - encoding of the files to parse

followSymbolicLinks - determines whether the visitor should traverse symbolic

parser - the parser to use

errorOnEmptyFiles - determines whether the visitor should log errors if a file is empty

Method Details

processFile

protected Optional<edu.hm.hafner.analysis.Report> processFile(Path file,
 Charset charset,
 edu.hm.hafner.util.FilteredLog log)

Specified by:

processFile in class io.jenkins.plugins.util.AgentFileVisitor<edu.hm.hafner.analysis.Report>