Package hudson.model

Class TextParameterDefinition

java.lang.Object

hudson.model.ParameterDefinition

hudson.model.SimpleParameterDefinition

hudson.model.StringParameterDefinition

hudson.model.TextParameterDefinition

All Implemented Interfaces:

ExtensionPoint, Describable<ParameterDefinition>, Serializable

public class TextParameterDefinition
extends StringParameterDefinition

StringParameterDefinition that uses textarea, instead of text box.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TextParameterDefinition.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
TextParameterDefinition(String name)
TextParameterDefinition(String name, String defaultValue, String description)

Method Summary

Modifier and Type	Method	Description
ParameterValue	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)
StringParameterValue	getDefaultParameterValue()	Returns default parameter value for this definition.
int	hashCode()

Methods inherited from class hudson.model.StringParameterDefinition

copyWithDefaultValue, getDefaultValue, getDefaultValue4Build, isTrim, setDefaultValue, setTrim

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

TextParameterDefinition

@DataBoundConstructor
public TextParameterDefinition(@NonNull
 String name)

Since:

2.281

TextParameterDefinition

public TextParameterDefinition(@NonNull
 String name,
 @CheckForNull
 String defaultValue,
 @CheckForNull
 String description)

Method Details

getDefaultParameterValue

public StringParameterValue getDefaultParameterValue()

Description copied from class: ParameterDefinition

Returns default parameter value for this definition.

Overrides:

getDefaultParameterValue in class StringParameterDefinition

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 StringParameterDefinition

createValue

public ParameterValue createValue(String value)

Description copied from class: SimpleParameterDefinition

Creates a ParameterValue from the string representation.

Overrides:

createValue in class StringParameterDefinition

hashCode

public int hashCode()

Overrides:

hashCode in class StringParameterDefinition

equals

public boolean equals(Object obj)

Overrides:

equals in class StringParameterDefinition