Package io.jenkins.plugins.restlistparam

Class RestListParameterDefinition

java.lang.Object

hudson.model.ParameterDefinition

hudson.model.SimpleParameterDefinition

io.jenkins.plugins.restlistparam.RestListParameterDefinition

All Implemented Interfaces:

ExtensionPoint, Describable<ParameterDefinition>, Serializable

public final class RestListParameterDefinition
extends SimpleParameterDefinition

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RestListParameterDefinition.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
RestListParameterDefinition(String name, String description, String restEndpoint, String credentialId, MimeType mimeType, String valueExpression, String displayExpression)
RestListParameterDefinition(String name, String description, String restEndpoint, String credentialId, MimeType mimeType, String valueExpression, String displayExpression, ValueOrder valueOrder, String filter, Integer cacheTime, String defaultValue, boolean allowEmptyValue)

Method Summary

Modifier and Type	Method	Description
ParameterDefinition	copyWithDefaultValue(ParameterValue defaultValue)
ParameterValue	createValue(String value)
ParameterValue	createValue(org.kohsuke.stapler.StaplerRequest2 req, net.sf.json.JSONObject jo)
boolean	equals(Object obj)
Integer	getCacheTime()
String	getCredentialId()
String	getDefaultValue()
String	getDisplayExpression()
String	getErrorMsg()
String	getFilter()
MimeType	getMimeType()
String	getRestEndpoint()
String	getValueExpression()
ValueOrder	getValueOrder()
List<ValueItem>	getValues()
int	hashCode()
boolean	isAllowEmptyValue()
boolean	isEnableValidation()
boolean	isValid(ParameterValue value)
void	setAllowEmptyValue(boolean allowEmptyValue)
void	setCacheTime(Integer cacheTime)
void	setDefaultValue(String defaultValue)
void	setDisplayExpression(String displayExpression)
void	setEnableValidation(boolean enableValidation)
void	setFilter(String filter)
void	setValueOrder(ValueOrder valueOrder)

Methods inherited from class hudson.model.SimpleParameterDefinition

createValue, createValue

Methods inherited from class hudson.model.ParameterDefinition

all, createValue, createValue, getDefaultParameterValue, getDescription, getDescriptor, getFormattedDescription, getName, getType, setDescription

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RestListParameterDefinition

@DataBoundConstructor
public RestListParameterDefinition(String name,
 String description,
 String restEndpoint,
 String credentialId,
 MimeType mimeType,
 String valueExpression,
 String displayExpression)

RestListParameterDefinition

public RestListParameterDefinition(String name,
 String description,
 String restEndpoint,
 String credentialId,
 MimeType mimeType,
 String valueExpression,
 String displayExpression,
 ValueOrder valueOrder,
 String filter,
 Integer cacheTime,
 String defaultValue,
 boolean allowEmptyValue)

Method Details

getRestEndpoint

public String getRestEndpoint()

getCredentialId

public String getCredentialId()

getMimeType

public MimeType getMimeType()

getValueExpression

public String getValueExpression()

getFilter

public String getFilter()

getDisplayExpression

public String getDisplayExpression()

setDisplayExpression

@DataBoundSetter
public void setDisplayExpression(String displayExpression)

setValueOrder

@DataBoundSetter
public void setValueOrder(ValueOrder valueOrder)

getValueOrder

public ValueOrder getValueOrder()

setFilter

@DataBoundSetter
public void setFilter(String filter)

getCacheTime

public Integer getCacheTime()

setCacheTime

@DataBoundSetter
public void setCacheTime(Integer cacheTime)

getDefaultValue

public String getDefaultValue()

setDefaultValue

@DataBoundSetter
public void setDefaultValue(String defaultValue)

isAllowEmptyValue

public boolean isAllowEmptyValue()

setAllowEmptyValue

@DataBoundSetter
public void setAllowEmptyValue(boolean allowEmptyValue)

isEnableValidation

public boolean isEnableValidation()

setEnableValidation

@DataBoundSetter
public void setEnableValidation(boolean enableValidation)

getErrorMsg

public String getErrorMsg()

getValues

public List<ValueItem> getValues()

copyWithDefaultValue

public ParameterDefinition copyWithDefaultValue(ParameterValue defaultValue)

Overrides:

copyWithDefaultValue in class ParameterDefinition

createValue

public ParameterValue createValue(String value)

Specified by:

createValue in class SimpleParameterDefinition

createValue

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

Overrides:

createValue in class ParameterDefinition

isValid

public boolean isValid(ParameterValue value)

Overrides:

isValid in class ParameterDefinition

hashCode

public int hashCode()

Overrides:

hashCode in class ParameterDefinition

equals

public boolean equals(Object obj)

Overrides:

equals in class ParameterDefinition