jp.ikedam.jenkins.plugins.extensible_choice_parameter

Class SystemGroovyChoiceListProvider

java.lang.Object

hudson.model.AbstractDescribableImpl<ChoiceListProvider>

jp.ikedam.jenkins.plugins.extensible_choice_parameter.ChoiceListProvider

jp.ikedam.jenkins.plugins.extensible_choice_parameter.SystemGroovyChoiceListProvider

All Implemented Interfaces:

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

public class SystemGroovyChoiceListProvider
extends ChoiceListProvider
implements Serializable

A choice provider whose choices are determined by a Groovy script.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SystemGroovyChoiceListProvider.DescriptorImpl The internal class to work with views.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
SystemGroovyChoiceListProvider(String scriptText, String defaultChoice)
SystemGroovyChoiceListProvider(String scriptText, String defaultChoice, boolean usePredefinedVariables) Constructor instantiating with parameters in the configuration page.

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	getChoiceList() Returns the list of choices the user specified in the job configuration page.
String	getDefaultChoice() Returns the default choice.
protected hudson.model.AbstractProject<?,?>	getProject() Return the project where this is configured.
String	getScriptText() The list of choices, joined into a string.
boolean	isUsePredefinedVariables()
protected void	setProject(hudson.model.AbstractProject<?,?> project)

Methods inherited from class jp.ikedam.jenkins.plugins.extensible_choice_parameter.ChoiceListProvider

all, onBuildCompletedWithValue, onBuildTriggeredWithValue

Methods inherited from class hudson.model.AbstractDescribableImpl

getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Detail

SystemGroovyChoiceListProvider

@DataBoundConstructor
public SystemGroovyChoiceListProvider(String scriptText,
                                                   String defaultChoice,
                                                   boolean usePredefinedVariables)

Constructor instantiating with parameters in the configuration page. When instantiating from the saved configuration, the object is directly serialized with XStream, and no constructor is used.

Parameters:

scriptText - the text where choices are written in each line.

defaultChoice -

usePredefinedVariables -

SystemGroovyChoiceListProvider

public SystemGroovyChoiceListProvider(String scriptText,
                              String defaultChoice)

Method Detail

getChoiceList

public List<String> getChoiceList()

Returns the list of choices the user specified in the job configuration page.

Specified by:

getChoiceList in class ChoiceListProvider

Returns:

the list of choices.

See Also:

ChoiceListProvider.getChoiceList()

getScriptText

public String getScriptText()

The list of choices, joined into a string. Used for filling a field when the configuration page is shown.

Returns:

Joined choices.

getDefaultChoice

public String getDefaultChoice()

Returns the default choice.

Overrides:

getDefaultChoice in class ChoiceListProvider

Returns:

the default choice

See Also:

ChoiceListProvider.getDefaultChoice()

isUsePredefinedVariables

public boolean isUsePredefinedVariables()

Returns:

whether to use predefined variables

setProject

protected void setProject(hudson.model.AbstractProject<?,?> project)

Parameters:

project -

getProject

protected hudson.model.AbstractProject<?,?> getProject()

Return the project where this is configured. This is set only when isUsePredefinedVariables() is true.

Returns:

project