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

Klasse Tool.ToolDescriptor

java.lang.Object

hudson.model.Descriptor<Tool>

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

Alle implementierten Schnittstellen:

Saveable, OnMaster

Bekannte direkte Unterklassen:

AxivionSuite.AxivionSuiteToolDescriptor, OpenTasks.Descriptor, ReportScanningTool.ReportScanningToolDescriptor

Umschließende Klasse:

Tool

public abstract static class Tool.ToolDescriptor
extends Descriptor<Tool>

Descriptor for Tool.

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	ToolDescriptor(String defaultId)	Creates a new instance of Tool.ToolDescriptor with the given ID.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
FormValidation	doCheckId(BuildableItem project, String id)	Performs on-the-fly validation of the ID.
String	getHelp()	Returns an optional help text that can provide useful hints on how to configure the static analysis tool so that the report files could be parsed by Jenkins.
String	getId()
StaticAnalysisLabelProvider	getLabelProvider()	Returns a StaticAnalysisLabelProvider that will render all tool specific labels.
String	getName()	Returns the default name of this tool.
String	getSymbolName()	Returns the Symbol name of this tool.
String	getUrl()	Returns an optional URL to the homepage of the static analysis tool.
boolean	isPostProcessingEnabled()	Returns whether post-processing on the agent is enabled for this tool.

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

ToolDescriptor

protected ToolDescriptor(String defaultId)

Creates a new instance of Tool.ToolDescriptor with the given ID.

Parameter:

defaultId - the unique ID of the tool

Methodendetails

doCheckId

@POST
public FormValidation doCheckId(@AncestorInPath
 BuildableItem project,
 @QueryParameter
 String id)

Performs on-the-fly validation of the ID.

Parameter:

project - the project that is configured

id - the ID of the tool

Gibt zurück:

the validation result

getId

public String getId()

Setzt außer Kraft:

getId in Klasse Descriptor<Tool>

getName

public String getName()

Returns the default name of this tool.

Gibt zurück:

the name

getSymbolName

public String getSymbolName()

Returns the Symbol name of this tool.

Gibt zurück:

the name of this tool, or "undefined" if no symbol has been defined

getLabelProvider

public StaticAnalysisLabelProvider getLabelProvider()

Returns a StaticAnalysisLabelProvider that will render all tool specific labels.

Gibt zurück:

a tool specific StaticAnalysisLabelProvider

getHelp

public String getHelp()

Returns an optional help text that can provide useful hints on how to configure the static analysis tool so that the report files could be parsed by Jenkins. This help can be a plain text message or an HTML snippet.

Gibt zurück:

the help

getUrl

public String getUrl()

Returns an optional URL to the homepage of the static analysis tool.

Gibt zurück:

the help

isPostProcessingEnabled

public boolean isPostProcessingEnabled()

Returns whether post-processing on the agent is enabled for this tool. If enabled, for all issues absolute paths, fingerprints, packages and modules will be detected. Additionally, all affected files will be saved in the build so that these files can be shown in the UI later on.,

Gibt zurück:

true if post-processing is enabled, false otherwise