Package org.jvnet.jenkins.plugins.nodelabelparameter

Interface MultipleNodeDescribingParameterDefinition

All Known Implementing Classes:

LabelParameterDefinition, NodeParameterDefinition

public interface MultipleNodeDescribingParameterDefinition

Author:

Dominik Bartholdi (imod)

Method Summary

Modifier and Type	Method	Description
TriggerNextBuildWrapper	createBuildWrapper()	Returns the wrapper to trigger the next build
String	getName()	The name of the parameter
NodeEligibility	getNodeEligibility()	gets the strategy which decides whether a node should be ignored or not
String	getTriggerIfResult()	Get the requested build result definition
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.

Method Details

getTriggerIfResult

String getTriggerIfResult()

Get the requested build result definition

Returns:

build result string that will trigger the job

getName

String getName()

The name of the parameter

Returns:

the name of the parameter

getNodeEligibility

NodeEligibility getNodeEligibility()

gets the strategy which decides whether a node should be ignored or not

Returns:

the eligibility definition

validateBuild

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. Implementations are asked to throw a runtime exception if something is not OK and the build should be stopped.

Parameters:

build - build to be validated

launcher - build launcher

listener - provides access to the log stream

createBuildWrapper

TriggerNextBuildWrapper createBuildWrapper()

Returns the wrapper to trigger the next build

Returns:

null if there is no new build to be triggered.