Package hudson.model

Class RunParameterDefinition

java.lang.Object

hudson.model.ParameterDefinition

hudson.model.SimpleParameterDefinition

hudson.model.RunParameterDefinition

All Implemented Interfaces:

ExtensionPoint, Describable<ParameterDefinition>, Serializable

public class RunParameterDefinition
extends SimpleParameterDefinition

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RunParameterDefinition.DescriptorImpl
static enum	RunParameterDefinition.RunParameterFilter	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

Constructors

Constructor	Description
RunParameterDefinition(String name, String projectName, String description)	Deprecated. as of 1.517
RunParameterDefinition(String name, String projectName, String description, RunParameterDefinition.RunParameterFilter filter)

Method Summary

Modifier and Type	Method	Description
ParameterDefinition	copyWithDefaultValue(ParameterValue defaultValue)	Create a new instance of this parameter definition and use the passed parameter value as the default value.
RunParameterValue	createValue(String value)	Creates a ParameterValue from the string representation.
ParameterValue	createValue(org.kohsuke.stapler.StaplerRequest2 req, net.sf.json.JSONObject jo)	Create a parameter value from a form submission.
boolean	equals(Object obj)
RunList	getBuilds()
ParameterValue	getDefaultParameterValue()	Returns default parameter value for this definition.
RunParameterDefinition.RunParameterFilter	getFilter()
Job	getProject()
String	getProjectName()
int	hashCode()

Methods inherited from class hudson.model.SimpleParameterDefinition

createValue, createValue

Methods inherited from class hudson.model.ParameterDefinition

all, createValue, createValue, getDescription, getDescriptor, getFormattedDescription, getName, getType, isValid, setDescription

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

public ParameterDefinition copyWithDefaultValue(ParameterValue defaultValue)

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 class ParameterDefinition

getProjectName

@Exported
public String getProjectName()

getProject

public Job getProject()

getFilter

@Exported
public RunParameterDefinition.RunParameterFilter getFilter()

Returns:

The current filter value, if filter is null, returns ALL

Since:

1.517

getBuilds

public RunList getBuilds()

Returns:

Returns a list of builds, filtered based on the filter value.

Since:

1.517

getDefaultParameterValue

public ParameterValue getDefaultParameterValue()

Description copied from class: ParameterDefinition

Returns default parameter value for this definition.

Overrides:

getDefaultParameterValue in class ParameterDefinition

Returns:

default parameter value or null if no defaults are available

createValue

public ParameterValue createValue(org.kohsuke.stapler.StaplerRequest2 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.

Overrides:

createValue in class ParameterDefinition

createValue

public RunParameterValue createValue(String value)

Description copied from class: SimpleParameterDefinition

Creates a ParameterValue from the string representation.

Specified by:

createValue in class SimpleParameterDefinition

hashCode

public int hashCode()

Overrides:

hashCode in class ParameterDefinition

equals

public boolean equals(Object obj)

Overrides:

equals in class ParameterDefinition