Package org.jvnet.jenkins.plugins.nodelabelparameter

Class LabelParameterDefinition.DescriptorImpl

java.lang.Object

hudson.model.Descriptor<ParameterDefinition>

hudson.model.ParameterDefinition.ParameterDescriptor

org.jvnet.jenkins.plugins.nodelabelparameter.LabelParameterDefinition.DescriptorImpl

All Implemented Interfaces:

Saveable, Loadable, OnMaster

Enclosing class:

LabelParameterDefinition

@Extension
public static class LabelParameterDefinition.DescriptorImpl
extends ParameterDefinition.ParameterDescriptor

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

Method Summary

Modifier and Type	Method	Description
AutoCompletionCandidates	doAutoCompleteDefaultValue(String value)	Called by UI - Autocompletion for label values
FormValidation	doCheckDefaultValue(String value)	Called by UI - Checks whether the given label is valid
FormValidation	doListNodesForLabel(String label)	Called by validation button in UI when triggering a job manually
NodeEligibility	getDefaultNodeEligibility()	provides the default node eligibility for the UI
String	getDisplayName()
String	getHelpFile()

Methods inherited from class hudson.model.ParameterDefinition.ParameterDescriptor

getValuePage

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

DescriptorImpl

public DescriptorImpl()

Method Details

getDisplayName

public String getDisplayName()

Overrides:

getDisplayName in class ParameterDefinition.ParameterDescriptor

getHelpFile

public String getHelpFile()

Overrides:

getHelpFile in class Descriptor<ParameterDefinition>

doAutoCompleteDefaultValue

public AutoCompletionCandidates doAutoCompleteDefaultValue(@QueryParameter
 String value)

Called by UI - Autocompletion for label values

Parameters:

value - the current value in the text field to base the automcompetion upon.

Returns:

autocompletion candidates for label values

doCheckDefaultValue

public FormValidation doCheckDefaultValue(@QueryParameter
 String value)

Called by UI - Checks whether the given label is valid

Parameters:

value - the label to be checked

Returns:

validation result for the form

doListNodesForLabel

public FormValidation doListNodesForLabel(@QueryParameter("value")
 String label)
                                   throws jakarta.servlet.ServletException

Called by validation button in UI when triggering a job manually

Parameters:

label - the label to search the nodes for

Returns:

if ok, a list of nodes matching the given label

Throws:

jakarta.servlet.ServletException - on error

getDefaultNodeEligibility

public NodeEligibility getDefaultNodeEligibility()

provides the default node eligibility for the UI