Package hudson.model
Class RunParameterDefinition
java.lang.Object
hudson.model.ParameterDefinition
hudson.model.SimpleParameterDefinition
hudson.model.RunParameterDefinition
- All Implemented Interfaces:
ExtensionPoint
,Describable<ParameterDefinition>
,Serializable
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
static enum
Constants that control how Run Parameter is filtered.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
ConstructorDescriptionRunParameterDefinition
(String name, String projectName, String description) Deprecated.as of 1.517RunParameterDefinition
(String name, String projectName, String description, RunParameterDefinition.RunParameterFilter filter) -
Method Summary
Modifier and TypeMethodDescriptioncopyWithDefaultValue
(ParameterValue defaultValue) Create a new instance of this parameter definition and use the passed parameter value as the default value.createValue
(String value) Creates aParameterValue
from the string representation.createValue
(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject jo) Create a parameter value from a form submission.boolean
Returns default parameter value for this definition.int
hashCode()
Methods inherited from class hudson.model.SimpleParameterDefinition
createValue, createValue
Methods inherited from class hudson.model.ParameterDefinition
all, getDescription, getDescriptor, getFormattedDescription, getName, getType, isValid, setDescription
-
Constructor Details
-
RunParameterDefinition
@DataBoundConstructor public RunParameterDefinition(@NonNull String name, String projectName, @CheckForNull String description, @CheckForNull RunParameterDefinition.RunParameterFilter filter) - Since:
- 1.517
-
RunParameterDefinition
@Deprecated public RunParameterDefinition(@NonNull String name, String projectName, @CheckForNull String description) Deprecated.as of 1.517
-
-
Method Details
-
copyWithDefaultValue
Description copied from class:ParameterDefinition
Create a new instance of this parameter definition and use the passed parameter value as the default value.- Overrides:
copyWithDefaultValue
in classParameterDefinition
-
getProjectName
-
getProject
-
getFilter
- Returns:
- The current filter value, if filter is null, returns ALL
- Since:
- 1.517
-
getBuilds
- Returns:
- Returns a list of builds, filtered based on the filter value.
- Since:
- 1.517
-
getDefaultParameterValue
Description copied from class:ParameterDefinition
Returns default parameter value for this definition.- Overrides:
getDefaultParameterValue
in classParameterDefinition
- Returns:
- default parameter value or null if no defaults are available
-
createValue
public ParameterValue createValue(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject jo) Description copied from class:ParameterDefinition
Create a parameter value from a form submission.This method is invoked when the user fills in the parameter values in the HTML form and submits it to the server.
- Specified by:
createValue
in classParameterDefinition
-
createValue
Description copied from class:SimpleParameterDefinition
Creates aParameterValue
from the string representation.- Specified by:
createValue
in classSimpleParameterDefinition
-
hashCode
public int hashCode()- Overrides:
hashCode
in classParameterDefinition
-
equals
- Overrides:
equals
in classParameterDefinition
-