Package hudson.model

Class PasswordParameterDefinition

java.lang.Object

hudson.model.ParameterDefinition

hudson.model.SimpleParameterDefinition

hudson.model.PasswordParameterDefinition

All Implemented Interfaces:

ExtensionPoint, Describable<ParameterDefinition>, Serializable

public class PasswordParameterDefinition
extends SimpleParameterDefinition

Parameter whose value is a Secret and is hidden from the UI.

Since:

1.319

Author:

Kohsuke Kawaguchi

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	PasswordParameterDefinition.ParameterDescriptorImpl

Nested classes/interfaces inherited from class hudson.model.ParameterDefinition

ParameterDefinition.ParameterDescriptor

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_VALUE

Fields inherited from class hudson.model.ParameterDefinition

LIST

Constructor Summary

Constructors

Constructor	Description
PasswordParameterDefinition(String name, Secret defaultValueAsSecret, String description)
PasswordParameterDefinition(String name, String defaultValue, String description)	Deprecated.

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.
PasswordParameterValue	createValue(org.kohsuke.stapler.StaplerRequest2 req, net.sf.json.JSONObject jo)	Create a parameter value from a form submission.
boolean	equals(Object obj)
ParameterValue	getDefaultParameterValue()	Returns default parameter value for this definition.
String	getDefaultValue()
Secret	getDefaultValueAsSecret()
int	hashCode()
void	setDefaultValue(String defaultValue)

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

Field Details

DEFAULT_VALUE

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public static final String DEFAULT_VALUE

See Also:

• Constant Field Values

Constructor Details

PasswordParameterDefinition

@Deprecated
public PasswordParameterDefinition(@NonNull
 String name,
 @CheckForNull
 String defaultValue,
 @CheckForNull
 String description)

Deprecated.

PasswordParameterDefinition

@DataBoundConstructor
public PasswordParameterDefinition(@NonNull
 String name,
 @CheckForNull
 Secret defaultValueAsSecret,
 @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

createValue

public ParameterValue createValue(String value)

Description copied from class: SimpleParameterDefinition

Creates a ParameterValue from the string representation.

Specified by:

createValue in class SimpleParameterDefinition

createValue

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

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

getDefaultValue

@NonNull
public String getDefaultValue()

getDefaultValueAsSecret

@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
public Secret getDefaultValueAsSecret()

setDefaultValue

public void setDefaultValue(String defaultValue)

hashCode

public int hashCode()

Overrides:

hashCode in class ParameterDefinition

equals

public boolean equals(Object obj)

Overrides:

equals in class ParameterDefinition