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

Class Tool.ToolDescriptor

java.lang.Object

hudson.model.Descriptor<Tool>

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

All Implemented Interfaces:

Saveable, Loadable, OnMaster

Direct Known Subclasses:

AxivionSuite.AxivionSuiteToolDescriptor, OpenTasks.Descriptor, ReportScanningTool.ReportScanningToolDescriptor

Enclosing class:

Tool

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

Descriptor for Tool.

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.Descriptor

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Field Summary

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ToolDescriptor(String defaultId)	Creates a new instance of Tool.ToolDescriptor with the given ID.

Method Summary

Modifier and Type	Method	Description
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.

Methods inherited from class 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, getStaticHelpUrl, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

Methods inherited from class java.lang.Object

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

Constructor Details

ToolDescriptor

protected ToolDescriptor(String defaultId)

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

Parameters:

defaultId - the unique ID of the tool

Method Details

doCheckId

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

Performs on-the-fly validation of the ID.

Parameters:

project - the project that is configured

id - the ID of the tool

Returns:

the validation result

getId

public String getId()

Overrides:

getId in class Descriptor<Tool>

getName

public String getName()

Returns the default name of this tool.

Returns:

the name

getSymbolName

public String getSymbolName()

Returns the Symbol name of this tool.

Returns:

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.

Returns:

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.

Returns:

the help

getUrl

public String getUrl()

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

Returns:

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.,

Returns:

true if post-processing is enabled, false otherwise