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

Klasse ReportScanningTool

java.lang.Object

hudson.model.AbstractDescribableImpl<Tool>

io.jenkins.plugins.analysis.core.model.Tool

io.jenkins.plugins.analysis.core.model.ReportScanningTool

Alle implementierten Schnittstellen:

Describable<Tool>, Serializable

Bekannte direkte Unterklassen:

AnalysisModelParser, GroovyScript, RegisteredParser

public abstract class ReportScanningTool
extends Tool

Describes a static analysis tool that reports issues by scanning a report file. Report files are identified using an Ant style pattern.

Autor:

Ullrich Hafner

Siehe auch:

• Serialisierte Form

Verschachtelte Klassen - Übersicht

Verschachtelte Klassen

Modifizierer und Typ	Klasse	Beschreibung
static class	ReportScanningTool.ReportScanningToolDescriptor	Descriptor for ReportScanningTool.

Von Klasse geerbte verschachtelte Klassen/Schnittstellen io.jenkins.plugins.analysis.core.model.Tool

Tool.ToolDescriptor

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
ReportScanningTool()

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
abstract edu.hm.hafner.analysis.IssueParser	createParser()	Returns a new parser to scan a log file and return the issues reported in such a file.
String	getActualPattern()	Returns the actual pattern to work with.
ReportScanningTool.ReportScanningToolDescriptor	getDescriptor()
String	getPattern()
String	getReportEncoding()
boolean	getSkipSymbolicLinks()
edu.hm.hafner.analysis.Report	scan(Run<?,?> run, FilePath workspace, Charset sourceCodeEncoding, io.jenkins.plugins.util.LogHandler logger)	Scans the results of a build for issues.
void	setPattern(String pattern)	Sets the Ant file-set pattern of files to work with.
void	setReportEncoding(String reportEncoding)	Sets the encoding to use to read the log files that contain the warnings.
void	setSkipSymbolicLinks(boolean skipSymbolicLinks)	Specify if file scanning skip traversal of symbolic links.

Von Klasse geerbte Methoden io.jenkins.plugins.analysis.core.model.Tool

getActualId, getActualName, getId, getLabelProvider, getName, getSymbolName, readResolve, setId, setJenkinsFacade, setName

Von Klasse geerbte Methoden java.lang.Object

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

Konstruktordetails

ReportScanningTool

public ReportScanningTool()

Methodendetails

setPattern

@DataBoundSetter
public void setPattern(String pattern)

Sets the Ant file-set pattern of files to work with. If the pattern is undefined then the console log is scanned.

Parameter:

pattern - the pattern to use

getPattern

@CheckForNull
public String getPattern()

getActualPattern

public String getActualPattern()

Returns the actual pattern to work with. If no user defined pattern is given, then the default pattern is returned.

Gibt zurück:

the name

Siehe auch:

• setPattern(String)
• AnalysisModelParser.AnalysisModelParserDescriptor.getPattern()

getDescriptor

public ReportScanningTool.ReportScanningToolDescriptor getDescriptor()

Angegeben von:

getDescriptor in Schnittstelle Describable<Tool>

Setzt außer Kraft:

getDescriptor in Klasse Tool

createParser

public abstract edu.hm.hafner.analysis.IssueParser createParser()

Returns a new parser to scan a log file and return the issues reported in such a file.

Gibt zurück:

the parser to use

setSkipSymbolicLinks

@DataBoundSetter
public void setSkipSymbolicLinks(boolean skipSymbolicLinks)

Specify if file scanning skip traversal of symbolic links.

Parameter:

skipSymbolicLinks - if symbolic links should be skipped during directory scanning.

getSkipSymbolicLinks

public boolean getSkipSymbolicLinks()

setReportEncoding

@DataBoundSetter
public void setReportEncoding(String reportEncoding)

Sets the encoding to use to read the log files that contain the warnings.

Parameter:

reportEncoding - the encoding, e.g. "ISO-8859-1"

getReportEncoding

@CheckForNull
public String getReportEncoding()

scan

public edu.hm.hafner.analysis.Report scan(Run<?,?> run,
 FilePath workspace,
 Charset sourceCodeEncoding,
 io.jenkins.plugins.util.LogHandler logger)

Beschreibung aus Klasse kopiert: Tool

Scans the results of a build for issues. This method is invoked on Jenkins master. I.e., if a tool wants to process some build results it is required to run a MasterToSlaveCallable.

Angegeben von:

scan in Klasse Tool

Parameter:

run - the build

workspace - the workspace of the build

sourceCodeEncoding - the encoding to use to read source files

logger - the logger

Gibt zurück:

the created report