Klasse Tool.ToolDescriptor
- Bekannte direkte Unterklassen:
AxivionSuite.AxivionSuiteToolDescriptor
,OpenTasks.Descriptor
,ReportScanningTool.ReportScanningToolDescriptor
- Umschließende Klasse:
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
-
Konstruktorübersicht
ModifiziererKonstruktorBeschreibungprotected
ToolDescriptor
(String defaultId) Creates a new instance ofTool.ToolDescriptor
with the given ID. -
Methodenübersicht
Modifizierer und TypMethodeBeschreibungdoCheckId
(BuildableItem project, String id) Performs on-the-fly validation of the ID.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.getId()
Returns aStaticAnalysisLabelProvider
that will render all tool specific labels.getName()
Returns the default name of this tool.Returns theSymbol
name of this tool.getUrl()
Returns an optional URL to the homepage of the static analysis tool.boolean
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
-
Konstruktordetails
-
ToolDescriptor
Creates a new instance ofTool.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 configuredid
- the ID of the tool- Gibt zurück:
- the validation result
-
getId
- Setzt außer Kraft:
getId
in KlasseDescriptor<Tool>
-
getName
Returns the default name of this tool.- Gibt zurück:
- the name
-
getSymbolName
Returns theSymbol
name of this tool.- Gibt zurück:
- the name of this tool, or "undefined" if no symbol has been defined
-
getLabelProvider
Returns aStaticAnalysisLabelProvider
that will render all tool specific labels.- Gibt zurück:
- a tool specific
StaticAnalysisLabelProvider
-
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
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
-