Package hudson.model

Class BooleanParameterDefinition

java.lang.Object

hudson.model.ParameterDefinition

hudson.model.SimpleParameterDefinition

hudson.model.BooleanParameterDefinition

All Implemented Interfaces:

ExtensionPoint, Describable<ParameterDefinition>, Serializable

public class BooleanParameterDefinition
extends SimpleParameterDefinition

ParameterDefinition that is either 'true' or 'false'.

Author:

huybrechts

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BooleanParameterDefinition.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 inherited from class hudson.model.ParameterDefinition

LIST

Constructor Summary

Constructors

Constructor	Description
BooleanParameterDefinition(String name)
BooleanParameterDefinition(String name, boolean defaultValue, String description)

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.
ParameterValue	createValue(String value)	Creates a ParameterValue from the string representation.
ParameterValue	createValue(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject jo)	Create a parameter value from a form submission.
boolean	equals(Object obj)
BooleanParameterValue	getDefaultParameterValue()	Returns default parameter value for this definition.
int	hashCode()
boolean	isDefaultValue()
void	setDefaultValue(boolean defaultValue)

Methods inherited from class hudson.model.SimpleParameterDefinition

createValue, createValue

Methods inherited from class hudson.model.ParameterDefinition

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

BooleanParameterDefinition

@DataBoundConstructor
public BooleanParameterDefinition(@NonNull
 String name)

Since:

2.281

BooleanParameterDefinition

public BooleanParameterDefinition(@NonNull
 String name,
 boolean defaultValue,
 @CheckForNull
 String description)

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

isDefaultValue

public boolean isDefaultValue()

setDefaultValue

@DataBoundSetter
public void setDefaultValue(boolean defaultValue)

Since:

2.281

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

createValue

public ParameterValue createValue(String value)

Description copied from class: SimpleParameterDefinition

Creates a ParameterValue from the string representation.

Specified by:

createValue in class SimpleParameterDefinition

getDefaultParameterValue

public BooleanParameterValue 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

hashCode

public int hashCode()

Overrides:

hashCode in class ParameterDefinition

equals

public boolean equals(Object obj)

Overrides:

equals in class ParameterDefinition