Package io.jenkins.plugins.coverage.metrics.steps

Class CoverageStep.Descriptor

java.lang.Object

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

org.jenkinsci.plugins.workflow.steps.StepDescriptor

io.jenkins.plugins.coverage.metrics.steps.CoverageStep.Descriptor

All Implemented Interfaces:

Saveable, Loadable, OnMaster

Enclosing class:

CoverageStep

@Extension
public static class CoverageStep.Descriptor
extends org.jenkinsci.plugins.workflow.steps.StepDescriptor

Descriptor for this step: defines the context and the UI labels.

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
Descriptor()

Method Summary

Modifier and Type	Method	Description
String	argumentsToString(Map<String,Object> namedArgs)
FormValidation	doCheckId(BuildableItem project, String id)	Performs on-the-fly validation of the ID.
FormValidation	doCheckSourceCodeEncoding(BuildableItem project, String sourceCodeEncoding)	Performs on-the-fly validation on the character encoding.
ListBoxModel	doFillChecksAnnotationScopeItems()	Returns a model with all CoverageRecorder.ChecksAnnotationScope scopes.
ComboBoxModel	doFillSourceCodeEncodingItems()	Returns a model with all available charsets.
ListBoxModel	doFillSourceCodeRetentionItems()	Returns a model with all SourceCodeRetention strategies.
String	getDisplayName()
String	getFunctionName()
Set<? extends Class<?>>	getRequiredContext()

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

all, allMeta, byFunctionName, checkContextAvailability, defineArguments, getMetaStepArgumentType, getProvidedContext, 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, 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

Descriptor

public Descriptor()

Method Details

getFunctionName

public String getFunctionName()

Specified by:

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

getDisplayName

@NonNull
public String getDisplayName()

Overrides:

getDisplayName in class Descriptor<org.jenkinsci.plugins.workflow.steps.Step>

getRequiredContext

public Set<? extends Class<?>> getRequiredContext()

Specified by:

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

argumentsToString

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

Overrides:

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

doFillSourceCodeRetentionItems

@POST
public ListBoxModel doFillSourceCodeRetentionItems()

Returns a model with all SourceCodeRetention strategies.

Returns:

a model with all SourceCodeRetention strategies.

doFillChecksAnnotationScopeItems

@POST
public ListBoxModel doFillChecksAnnotationScopeItems()

Returns a model with all CoverageRecorder.ChecksAnnotationScope scopes.

Returns:

a model with all CoverageRecorder.ChecksAnnotationScope scopes.

doFillSourceCodeEncodingItems

@POST
public ComboBoxModel doFillSourceCodeEncodingItems()

Returns a model with all available charsets.

Returns:

a model with all available charsets

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

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