Package io.jenkins.plugins.analysis.core.steps

Class AnalysisStepDescriptor

java.lang.Object

hudson.model.Descriptor<org.jenkinsci.plugins.workflow.steps.Step>

org.jenkinsci.plugins.workflow.steps.StepDescriptor

io.jenkins.plugins.analysis.core.steps.AnalysisStepDescriptor

All Implemented Interfaces:

Saveable, Loadable, OnMaster

Direct Known Subclasses:

PublishIssuesStep.Descriptor, RecordIssuesStep.Descriptor, ScanForIssuesStep.Descriptor

public abstract class AnalysisStepDescriptor
extends org.jenkinsci.plugins.workflow.steps.StepDescriptor

Descriptor base class for all analysis steps. Provides generic validation methods and list box models for UI select elements.

Author:

Ullrich Hafner

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

Constructor	Description
AnalysisStepDescriptor()

Method Summary

Modifier and Type	Method	Description
String	argumentsToString(Map<String,Object> namedArgs)
FormValidation	doCheckHealthy(BuildableItem project, int healthy, int unhealthy)	Performs on-the-fly validation of the health report thresholds.
FormValidation	doCheckId(BuildableItem project, String id)	Performs on-the-fly validation of the ID.
FormValidation	doCheckReportEncoding(BuildableItem project, String reportEncoding)	Performs on-the-fly validation of the character encoding.
FormValidation	doCheckSourceCodeEncoding(BuildableItem project, String sourceCodeEncoding)	Performs on-the-fly validation on the character encoding.
FormValidation	doCheckUnhealthy(BuildableItem project, int healthy, int unhealthy)	Performs on-the-fly validation of the health report thresholds.
ListBoxModel	doFillChecksAnnotationScopeItems()	Returns a model with all WarningChecksPublisher.ChecksAnnotationScope scopes.
ListBoxModel	doFillMinimumSeverityItems()	Returns a model with all available severity filters.
ComboBoxModel	doFillSourceCodeEncodingItems(BuildableItem project)	Returns a model with all available charsets.
ListBoxModel	doFillSourceCodeRetentionItems()	Returns a model with all SourceCodeRetention strategies.
ListBoxModel	doFillTrendChartTypeItems()	Returns a model with all aggregation trend chart positions.
String	getDefaultIcon()
String	getDefaultId()
String	getDefaultName()

Methods inherited from class org.jenkinsci.plugins.workflow.steps.StepDescriptor

all, allMeta, byFunctionName, checkContextAvailability, defineArguments, getFunctionName, getMetaStepArgumentType, getProvidedContext, getRequiredContext, isAdvanced, isMetaStep, metaStepsOf, newInstance, takesImplicitBlockArgument, uninstantiate

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, bindJSON, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, configure, configure, doHelp, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getDisplayName, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, getStaticHelpUrl, getStaticHelpUrl, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, 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

AnalysisStepDescriptor

public AnalysisStepDescriptor()

Method Details

getDefaultId

public String getDefaultId()

getDefaultName

public String getDefaultName()

getDefaultIcon

public String getDefaultIcon()

doFillSourceCodeEncodingItems

@POST
public ComboBoxModel doFillSourceCodeEncodingItems(@AncestorInPath
 BuildableItem project)

Returns a model with all available charsets.

Parameters:

project - the project that is configured

Returns:

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.

Parameters:

project - the project that is configured

reportEncoding - the character encoding

Returns:

the validation result

doCheckSourceCodeEncoding

@POST
public FormValidation doCheckSourceCodeEncoding(@AncestorInPath
 BuildableItem project,
 @QueryParameter
 String sourceCodeEncoding)

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

Parameters:

project - the project that is configured

sourceCodeEncoding - the character encoding

Returns:

the validation result

doFillSourceCodeRetentionItems

@POST
public ListBoxModel doFillSourceCodeRetentionItems()

Returns a model with all SourceCodeRetention strategies.

Returns:

a model with all SourceCodeRetention strategies.

doFillMinimumSeverityItems

@POST
public ListBoxModel doFillMinimumSeverityItems()

Returns a model with all available severity filters.

Returns:

a model with all available severity filters

doCheckHealthy

@POST
public FormValidation doCheckHealthy(@AncestorInPath
 BuildableItem project,
 @QueryParameter
 int healthy,
 @QueryParameter
 int unhealthy)

Performs on-the-fly validation of the health report thresholds.

Parameters:

project - the project that is configured

healthy - the healthy threshold

unhealthy - the unhealthy threshold

Returns:

the validation result

doCheckUnhealthy

@POST
public FormValidation doCheckUnhealthy(@AncestorInPath
 BuildableItem project,
 @QueryParameter
 int healthy,
 @QueryParameter
 int unhealthy)

Performs on-the-fly validation of the health report thresholds.

Parameters:

project - the project that is configured

healthy - the healthy threshold

unhealthy - the unhealthy threshold

Returns:

the validation result

doFillTrendChartTypeItems

@POST
public ListBoxModel doFillTrendChartTypeItems()

Returns a model with all aggregation trend chart positions.

Returns:

a model with all aggregation trend chart positions

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

doFillChecksAnnotationScopeItems

@POST
public ListBoxModel doFillChecksAnnotationScopeItems()

Returns a model with all WarningChecksPublisher.ChecksAnnotationScope scopes.

Returns:

a model with all WarningChecksPublisher.ChecksAnnotationScope scopes.

argumentsToString

public String argumentsToString(@NonNull
 Map<String,Object> namedArgs)

Overrides:

argumentsToString in class org.jenkinsci.plugins.workflow.steps.StepDescriptor