Package hudson.plugins.validating_string_parameter

Class ValidatingStringParameterDefinition

java.lang.Object

hudson.model.ParameterDefinition

hudson.plugins.validating_string_parameter.ValidatingStringParameterDefinition

All Implemented Interfaces:

ExtensionPoint, Describable<ParameterDefinition>, Serializable

public class ValidatingStringParameterDefinition
extends ParameterDefinition

String based parameter that supports setting a regular expression to validate the user's entered value, giving real-time feedback on the value.

Since:

1.0

Author:

Peter Hayes

See Also:

• ParameterDefinition
• Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
ParameterValue	createValue(CLICommand command, String value)
ParameterValue	createValue(org.kohsuke.stapler.StaplerRequest req)
ParameterValue	createValue(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject jo)
ValidatingStringParameterValue	getDefaultParameterValue()
String	getDefaultValue()
String	getFailedValidationMessage()
String	getRegex()
String	getRootUrl()

Methods inherited from class hudson.model.ParameterDefinition

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

ValidatingStringParameterDefinition

@DataBoundConstructor
public ValidatingStringParameterDefinition(String name,
 String defaultValue,
 String regex,
 String failedValidationMessage,
 String description)

ValidatingStringParameterDefinition

public ValidatingStringParameterDefinition(String name,
 String defaultValue,
 String regex,
 String failedValidationMessage)

Method Details

getDefaultValue

public String getDefaultValue()

getRegex

public String getRegex()

getFailedValidationMessage

public String getFailedValidationMessage()

getRootUrl

public String getRootUrl()

getDefaultParameterValue

public ValidatingStringParameterValue getDefaultParameterValue()

Overrides:

getDefaultParameterValue in class ParameterDefinition

createValue

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

Specified by:

createValue in class ParameterDefinition

createValue

public ParameterValue createValue(org.kohsuke.stapler.StaplerRequest req)

Specified by:

createValue in class ParameterDefinition

createValue

public ParameterValue createValue(CLICommand command,
 String value)
                           throws IOException,
InterruptedException

Overrides:

createValue in class ParameterDefinition

Throws:

IOException

InterruptedException