Class LabelParameterDefinition
- java.lang.Object
-
- hudson.model.ParameterDefinition
-
- hudson.model.SimpleParameterDefinition
-
- org.jvnet.jenkins.plugins.nodelabelparameter.LabelParameterDefinition
-
- All Implemented Interfaces:
ExtensionPoint
,Describable<ParameterDefinition>
,Serializable
,MultipleNodeDescribingParameterDefinition
public class LabelParameterDefinition extends SimpleParameterDefinition implements MultipleNodeDescribingParameterDefinition
Defines a build parameter used to restrict the node a job will be executed on. Such a label works exactly the same way as if you would define it in the UI "restrict where this job should run".- Author:
- Dominik Bartholdi (imod)
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
LabelParameterDefinition.DescriptorImpl
-
Nested classes/interfaces inherited from class hudson.model.ParameterDefinition
ParameterDefinition.ParameterDescriptor
-
Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson
-
-
Field Summary
Fields Modifier and Type Field Description String
defaultValue
-
Fields inherited from class hudson.model.ParameterDefinition
LIST
-
-
Constructor Summary
Constructors Constructor Description LabelParameterDefinition(String name, String description, String defaultValue)
Deprecated.LabelParameterDefinition(String name, String description, String defaultValue, boolean allNodesMatchingLabel, boolean ignoreOfflineNodes, String triggerIfResult)
Deprecated.LabelParameterDefinition(String name, String description, String defaultValue, boolean allNodesMatchingLabel, NodeEligibility nodeEligibility, String triggerIfResult)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SimpleParameterDefinition
copyWithDefaultValue(ParameterValue defaultValueObj)
TriggerNextBuildWrapper
createBuildWrapper()
Returns the wrapper to trigger the next buildParameterValue
createValue(String str)
ParameterValue
createValue(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject jo)
LabelParameterValue
getDefaultParameterValue()
NodeEligibility
getNodeEligibility()
gets the strategy which decides whether a node should be ignored or notString
getTriggerIfResult()
Get the requested build result definitionboolean
isAllNodesMatchingLabel()
boolean
isTriggerConcurrentBuilds()
void
validateBuild(AbstractBuild<?,?> build, Launcher launcher, BuildListener listener)
Callback to allow the parameter definition to do a final validation if everything is OK to proceed.-
Methods inherited from class hudson.model.SimpleParameterDefinition
createValue, createValue
-
Methods inherited from class hudson.model.ParameterDefinition
all, equals, getDescription, getDescriptor, getFormattedDescription, getName, getType, hashCode, isValid, setDescription
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.jvnet.jenkins.plugins.nodelabelparameter.MultipleNodeDescribingParameterDefinition
getName
-
-
-
-
Field Detail
-
defaultValue
public final String defaultValue
-
-
Constructor Detail
-
LabelParameterDefinition
@DataBoundConstructor public LabelParameterDefinition(String name, String description, String defaultValue, boolean allNodesMatchingLabel, NodeEligibility nodeEligibility, String triggerIfResult)
-
LabelParameterDefinition
@Deprecated public LabelParameterDefinition(String name, String description, String defaultValue, boolean allNodesMatchingLabel, boolean ignoreOfflineNodes, String triggerIfResult)
Deprecated.
-
LabelParameterDefinition
@Deprecated public LabelParameterDefinition(String name, String description, String defaultValue)
Deprecated.
-
-
Method Detail
-
copyWithDefaultValue
public SimpleParameterDefinition copyWithDefaultValue(ParameterValue defaultValueObj)
- Overrides:
copyWithDefaultValue
in classParameterDefinition
-
getDefaultParameterValue
public LabelParameterValue getDefaultParameterValue()
- Overrides:
getDefaultParameterValue
in classParameterDefinition
-
isAllNodesMatchingLabel
public boolean isAllNodesMatchingLabel()
-
getNodeEligibility
public NodeEligibility getNodeEligibility()
Description copied from interface:MultipleNodeDescribingParameterDefinition
gets the strategy which decides whether a node should be ignored or not- Specified by:
getNodeEligibility
in interfaceMultipleNodeDescribingParameterDefinition
- Returns:
- the eligibility definition
-
createValue
public ParameterValue createValue(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject jo)
- Specified by:
createValue
in classParameterDefinition
-
createValue
public ParameterValue createValue(String str)
- Specified by:
createValue
in classSimpleParameterDefinition
-
getTriggerIfResult
public String getTriggerIfResult()
Description copied from interface:MultipleNodeDescribingParameterDefinition
Get the requested build result definition- Specified by:
getTriggerIfResult
in interfaceMultipleNodeDescribingParameterDefinition
- Returns:
- build result string that will trigger the job
-
isTriggerConcurrentBuilds
public boolean isTriggerConcurrentBuilds()
-
validateBuild
public void validateBuild(AbstractBuild<?,?> build, Launcher launcher, BuildListener listener)
Description copied from interface:MultipleNodeDescribingParameterDefinition
Callback to allow the parameter definition to do a final validation if everything is OK to proceed. Implementations are asked to throw a runtime exception if something is not OK and the build should be stopped.- Specified by:
validateBuild
in interfaceMultipleNodeDescribingParameterDefinition
- Parameters:
build
- build to be validatedlauncher
- build launcherlistener
- provides access to the log stream
-
createBuildWrapper
public TriggerNextBuildWrapper createBuildWrapper()
Description copied from interface:MultipleNodeDescribingParameterDefinition
Returns the wrapper to trigger the next build- Specified by:
createBuildWrapper
in interfaceMultipleNodeDescribingParameterDefinition
- Returns:
null
if there is no new build to be triggered.
-
-