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

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.ScriptlerStringParameterDefinition

All Implemented Interfaces:

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

public class ScriptlerStringParameterDefinition
extends ScriptlerParameterDefinition

Text parameter, with dynamically generated default value.

See Also:

Serialized Form

Nested Class Summary

static class

ScriptlerStringParameterDefinition.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

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

Method Summary

hudson.model.ParameterValue	getDefaultParameterValue() Return default parameter value - used by trigger mechanism.
String	getDefaultValue() Execute the script and return the default value for this parameter.
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

checkParameterValue, 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

ScriptlerStringParameterDefinition

@DataBoundConstructor
public ScriptlerStringParameterDefinition(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

getDefaultValue

public final String getDefaultValue()

Execute the script and return the default value for this parameter.

Returns:

the default value generated by the script or null

isReadonlyInputField

public boolean isReadonlyInputField()