com.seitenbau.jenkins.plugins.dynamicparameter
Class ChoiceParameterDefinition

java.lang.Object
  hudson.model.ParameterDefinition
      hudson.model.SimpleParameterDefinition
          com.seitenbau.jenkins.plugins.dynamicparameter.BaseParameterDefinition
              com.seitenbau.jenkins.plugins.dynamicparameter.ScriptParameterDefinition
                  com.seitenbau.jenkins.plugins.dynamicparameter.ChoiceParameterDefinition

All Implemented Interfaces:

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

public class ChoiceParameterDefinition
extends ScriptParameterDefinition

Choice parameter, with dynamically generated list of values.

See Also:

Serialized Form

Nested Class Summary

static class

ChoiceParameterDefinition.DescriptorImpl Parameter descriptor.

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

ScriptParameterDefinition.BaseDescriptor, ScriptParameterDefinition.ClasspathScriptCall

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

ChoiceParameterDefinition(String name, String script, String description, String uuid, boolean remote, boolean readonlyInputField, String classPath)
Constructor.

ChoiceParameterDefinition(String name, String script, String description, String uuid, boolean remote, String classPath)
Deprecated.

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 choice, 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.ScriptParameterDefinition

getClassPath, getClassPathList, getLocalBaseDirectory, getRemoteClassPath, getScript, 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

ChoiceParameterDefinition

@Deprecated
public ChoiceParameterDefinition(String name,
                                            String script,
                                            String description,
                                            String uuid,
                                            boolean remote,
                                            String classPath)

Deprecated.

ChoiceParameterDefinition

@DataBoundConstructor
public ChoiceParameterDefinition(String name,
                                                      String script,
                                                      String description,
                                                      String uuid,
                                                      boolean remote,
                                                      boolean readonlyInputField,
                                                      String classPath)

Constructor.

Parameters:

name - parameter name

script - script, which generates the parameter value

description - parameter description

uuid - identifier (optional)

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 choice, 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()