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

Klasse ReportScanningTool.ReportScanningToolDescriptor

java.lang.Object

hudson.model.Descriptor<Tool>

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

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

Alle implementierten Schnittstellen:

Saveable, OnMaster

Bekannte direkte Unterklassen:

AnalysisModelParser.AnalysisModelParserDescriptor, GroovyScript.Descriptor, RegisteredParser.Descriptor

Umschließende Klasse:

ReportScanningTool

public static class ReportScanningTool.ReportScanningToolDescriptor
extends Tool.ToolDescriptor

Descriptor for ReportScanningTool.

Autor:

Ullrich Hafner

Verschachtelte Klassen - Übersicht

Von Klasse geerbte verschachtelte Klassen/Schnittstellen hudson.model.Descriptor

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Feldübersicht

Von Klasse geerbte Felder hudson.model.Descriptor

clazz

Von Schnittstelle geerbte Felder hudson.model.Saveable

NOOP

Konstruktorübersicht

Konstruktoren

Modifizierer	Konstruktor	Beschreibung
protected	ReportScanningToolDescriptor(String id)	Creates a new instance of ReportScanningTool.ReportScanningToolDescriptor with the given ID.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
boolean	canScanConsoleLog()	Returns whether this parser can scan the console log.
FormValidation	doCheckPattern(AbstractProject<?,?> project, String pattern)	Performs on-the-fly validation on the ant pattern for input files.
FormValidation	doCheckReportEncoding(BuildableItem project, String reportEncoding)	Performs on-the-fly validation of the character encoding.
ComboBoxModel	doFillReportEncodingItems()	Returns a model with all available charsets.
String	getPattern()	Returns the default filename pattern for this tool.
boolean	hasDefaultPattern()	Indicates whether this scanning tool has a default pattern, or not.

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

doCheckId, getHelp, getId, getLabelProvider, getName, getSymbolName, getUrl, isPostProcessingEnabled

Von Klasse geerbte Methoden hudson.model.Descriptor

addHelpFileRedirect, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, configure, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getDisplayName, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

Von Klasse geerbte Methoden java.lang.Object

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

Konstruktordetails

ReportScanningToolDescriptor

protected ReportScanningToolDescriptor(String id)

Creates a new instance of ReportScanningTool.ReportScanningToolDescriptor with the given ID.

Parameter:

id - the unique ID of the tool

Methodendetails

doFillReportEncodingItems

@POST
public ComboBoxModel doFillReportEncodingItems()

Returns a model with all available charsets.

Gibt zurück:

a model with all available charsets

doCheckReportEncoding

@POST
public FormValidation doCheckReportEncoding(@AncestorInPath
 BuildableItem project,
 @QueryParameter
 String reportEncoding)

Performs on-the-fly validation of the character encoding.

Parameter:

project - the project that is configured

reportEncoding - the character encoding

Gibt zurück:

the validation result

doCheckPattern

@POST
public FormValidation doCheckPattern(@AncestorInPath
 AbstractProject<?,?> project,
 @QueryParameter
 String pattern)

Performs on-the-fly validation on the ant pattern for input files.

Parameter:

project - the project that is configured

pattern - the file pattern

Gibt zurück:

the validation result

hasDefaultPattern

public boolean hasDefaultPattern()

Indicates whether this scanning tool has a default pattern, or not. If it does, it means it can never scan the console, but also means that we don't require a user-specified pattern as we have a usable default.

Gibt zurück:

true if getPattern() returns a non-empty string.

canScanConsoleLog

public boolean canScanConsoleLog()

Returns whether this parser can scan the console log. Typically, only line-based parsers can scan the console log. XML parsers should always parse a given file only.

Gibt zurück:

the parser to use

getPattern

public String getPattern()

Returns the default filename pattern for this tool. Override if your parser typically works on a specific file. Note: if you provide a default pattern, then it is not possible to scan Jenkins' console log of a build.

Gibt zurück:

the default pattern