Package hudson.model

Class FileParameterDefinition

java.lang.Object

hudson.model.ParameterDefinition

hudson.model.FileParameterDefinition

All Implemented Interfaces:

ExtensionPoint, Describable<ParameterDefinition>, Serializable

public class FileParameterDefinition
extends ParameterDefinition

ParameterDefinition for doing file upload.

The file will be then placed into the workspace at the beginning of a build.

Author:

Kohsuke Kawaguchi

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
ParameterValue	createValue(CLICommand command, String value)	Create a parameter value from the string given in the CLI.
ParameterValue	createValue(org.kohsuke.stapler.StaplerRequest req)	Create a parameter value from a GET with query string.
FileParameterValue	createValue(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject jo)	Create a parameter value from a form submission.
boolean	equals(Object obj)
int	hashCode()

Methods inherited from class hudson.model.ParameterDefinition

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

FileParameterDefinition

@DataBoundConstructor
public FileParameterDefinition(@NonNull
 String name)

Since:

2.281

FileParameterDefinition

public FileParameterDefinition(@NonNull
 String name,
 @CheckForNull
 String description)

Method Details

createValue

public FileParameterValue 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(org.kohsuke.stapler.StaplerRequest req)

Description copied from class: ParameterDefinition

Create a parameter value from a GET with query string. If no value is available in the request, it returns a default value if possible, or null.

Unlike ParameterDefinition.createValue(StaplerRequest, JSONObject), this method is intended to support the programmatic POST-ing of the build URL. This form is less expressive (as it doesn't support the tree form), but it's more scriptable.

If a ParameterDefinition can't really support this mode of creating a value, you may just always return null.

Specified by:

createValue in class ParameterDefinition

createValue

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

Description copied from class: ParameterDefinition

Create a parameter value from the string given in the CLI.

Overrides:

createValue in class ParameterDefinition

Parameters:

command - This is the command that got the parameter.

Throws:

AbortException - If the CLI processing should be aborted. Hudson will report the error message without stack trace, and then exits this command. Useful for graceful termination.

IOException

InterruptedException

hashCode

public int hashCode()

Overrides:

hashCode in class ParameterDefinition

equals

public boolean equals(Object obj)

Overrides:

equals in class ParameterDefinition