com.seitenbau.jenkins.plugins.dynamicparameter
Class StringParameterDefinition

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

All Implemented Interfaces:

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

public class StringParameterDefinition
extends ScriptParameterDefinition

Text parameter, with dynamically generated default value.

See Also:

Serialized Form

Nested Class Summary

static class

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

StringParameterDefinition(String name, String script, String description, String uuid, boolean remote, boolean readonlyInputField, String classPath)
Constructor with the parameter which are injected by the jenkins runtime.

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

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

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

StringParameterDefinition

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

Deprecated.

Constructor is deprecated use instead the constructor with the read only parameter. Only some unit tests should depend on this constructor. Will be removed in the future.

StringParameterDefinition

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

Constructor with the parameter which are injected by the jenkins runtime.

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

readonlyInputField - should the input field marked as read only true / false

classPath - the class path description

Method Detail

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

getDefaultParameterValue

public hudson.model.ParameterValue getDefaultParameterValue()

Return default parameter value - used by trigger mechanism.

Overrides:

getDefaultParameterValue in class hudson.model.ParameterDefinition

isReadonlyInputField

public final boolean isReadonlyInputField()