com.seitenbau.jenkins.plugins.dynamicparameter.scriptler
Class ScriptlerChoiceParameterDefinition

java.lang.Object
  hudson.model.ParameterDefinition
      hudson.model.SimpleParameterDefinition
          com.seitenbau.jenkins.plugins.dynamicparameter.BaseParameterDefinition
              com.seitenbau.jenkins.plugins.dynamicparameter.scriptler.ScriptlerParameterDefinition
                  com.seitenbau.jenkins.plugins.dynamicparameter.scriptler.ScriptlerChoiceParameterDefinition

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.model.ParameterDefinition>, Serializable

public class ScriptlerChoiceParameterDefinition
extends ScriptlerParameterDefinition

Choice parameter, with dynamically generated list of values.

See Also:

Serialized Form

Nested Class Summary

static class

ScriptlerChoiceParameterDefinition.DescriptorImpl Parameter descriptor.

Nested classes/interfaces inherited from class com.seitenbau.jenkins.plugins.dynamicparameter.scriptler.ScriptlerParameterDefinition

ScriptlerParameterDefinition.ParameterizedScriptCall, ScriptlerParameterDefinition.ScriptParameter

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

hudson.model.ParameterDefinition.ParameterDescriptor

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class com.seitenbau.jenkins.plugins.dynamicparameter.BaseParameterDefinition

logger

Fields inherited from class hudson.model.ParameterDefinition

LIST

Constructor Summary

ScriptlerChoiceParameterDefinition(String name, String description, String uuid, String scriptlerScriptId, ScriptlerParameterDefinition.ScriptParameter[] parameters, boolean remote, boolean readonlyInputField)
Constructor.

Method Summary

protected hudson.model.StringParameterValue	checkParameterValue(hudson.model.StringParameterValue parameter) Check if the given parameter value is within the list of possible values.
List<Object>	getChoices() Get the possible choices, generated by the script.
hudson.model.ParameterValue	getDefaultParameterValue() Return default parameter value - used by trigger mechanism.
boolean	isReadonlyInputField()

Methods inherited from class com.seitenbau.jenkins.plugins.dynamicparameter.scriptler.ScriptlerParameterDefinition

getParameters, getScriptlerScriptId, prepareLocalCall, prepareRemoteCall

Methods inherited from class com.seitenbau.jenkins.plugins.dynamicparameter.BaseParameterDefinition

createValue, createValue, getScriptResultAsList, getScriptResultAsString, getUUID, isRemote

Methods inherited from class hudson.model.SimpleParameterDefinition

createValue, createValue

Methods inherited from class hudson.model.ParameterDefinition

all, copyWithDefaultValue, getDescription, getDescriptor, getName, getType

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptlerChoiceParameterDefinition

@DataBoundConstructor
public ScriptlerChoiceParameterDefinition(String name,
                                                               String description,
                                                               String uuid,
                                                               String scriptlerScriptId,
                                                               ScriptlerParameterDefinition.ScriptParameter[] parameters,
                                                               boolean remote,
                                                               boolean readonlyInputField)

Constructor.

Parameters:

name - parameter name

description - parameter description

uuid - identifier (optional)

scriptlerScriptId - Scriptler script id

parameters - script parameters

remote - execute the script on a remote node

Method Detail

getDefaultParameterValue

public hudson.model.ParameterValue getDefaultParameterValue()

Return default parameter value - used by trigger mechanism.

Overrides:

getDefaultParameterValue in class hudson.model.ParameterDefinition

getChoices

public final List<Object> getChoices()

Get the possible choices, generated by the script.

Returns:

list of values if the script returns a non-null list; Collections#EMPTY_LIST, otherwise

checkParameterValue

protected hudson.model.StringParameterValue checkParameterValue(hudson.model.StringParameterValue parameter)

Check if the given parameter value is within the list of possible values.

Overrides:

checkParameterValue in class BaseParameterDefinition

Parameters:

parameter - parameter value to check

Returns:

the value if it is valid

isReadonlyInputField

public boolean isReadonlyInputField()