Package io.jenkins.plugins.multibranchparams

Class MultiBranchHeaderParameter

java.lang.Object

hudson.model.ParameterDefinition

io.jenkins.plugins.multibranchparams.MultiBranchHeaderParameter

All Implemented Interfaces:

ExtensionPoint, Describable<ParameterDefinition>, Serializable

public class MultiBranchHeaderParameter
extends ParameterDefinition

A non-functional ParameterDefinition that renders a visual header on the "Build with Parameters" page, clearly marking which parameters were injected by the Multibranch Params plugin.

This class is never shown in the "Add Parameter" dropdown — it is only inserted programmatically by ParameterizedBranchProperty. Its createValue(org.kohsuke.stapler.StaplerRequest2, net.sf.json.JSONObject) methods return null so it contributes nothing to the build's ParametersAction.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MultiBranchHeaderParameter.DescriptorImpl	Descriptor for MultiBranchHeaderParameter.
static final class	MultiBranchHeaderParameter.MultiBranchHeaderValue	A ParameterValue that injects nothing into the build environment.

Nested classes/interfaces inherited from class hudson.model.ParameterDefinition

ParameterDefinition.ParameterDescriptor

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.model.ParameterDefinition

LIST

Constructor Summary

Constructors

Constructor	Description
MultiBranchHeaderParameter()

Method Summary

Modifier and Type	Method	Description
ParameterValue	createValue(org.kohsuke.stapler.StaplerRequest2 req)
ParameterValue	createValue(org.kohsuke.stapler.StaplerRequest2 req, net.sf.json.JSONObject jo)
ParameterValue	getDefaultParameterValue()

Methods inherited from class hudson.model.ParameterDefinition

all, copyWithDefaultValue, createValue, createValue, createValue, 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

Constructor Details

MultiBranchHeaderParameter

@DataBoundConstructor
public MultiBranchHeaderParameter()

Method Details

createValue

@CheckForNull
public ParameterValue createValue(org.kohsuke.stapler.StaplerRequest2 req,
 net.sf.json.JSONObject jo)

Overrides:

createValue in class ParameterDefinition

createValue

@CheckForNull
public ParameterValue createValue(org.kohsuke.stapler.StaplerRequest2 req)

Overrides:

createValue in class ParameterDefinition

getDefaultParameterValue

@CheckForNull
public ParameterValue getDefaultParameterValue()

Overrides:

getDefaultParameterValue in class ParameterDefinition