Package jp.ikedam.jenkins.plugins.extensible_choice_parameter

Class AddEditedChoiceListProvider

java.lang.Object

hudson.model.AbstractDescribableImpl<ChoiceListProvider>

jp.ikedam.jenkins.plugins.extensible_choice_parameter.ChoiceListProvider

jp.ikedam.jenkins.plugins.extensible_choice_parameter.AddEditedChoiceListProvider

All Implemented Interfaces:

ExtensionPoint, Describable<ChoiceListProvider>, Serializable

Direct Known Subclasses:

GlobalTextareaChoiceListProvider, TextareaChoiceListProvider

public abstract class AddEditedChoiceListProvider
extends ChoiceListProvider

ChoiceListProvider that can add edited value.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AddEditedChoiceListProvider.WhenToAdd	Used to Specify when to add a edited value

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
AddEditedChoiceListProvider(boolean addEditedValue, AddEditedChoiceListProvider.WhenToAdd whenToAdd)	Constructor

Method Summary

Modifier and Type	Method	Description
protected abstract void	addEditedValue(AbstractProject<?,?> project, ExtensibleChoiceParameterDefinition def, String value)	Called to add a edited value to the choice list.
AddEditedChoiceListProvider.WhenToAdd	getWhenToAdd()	Returns when to add a edited value.
boolean	isAddEditedValue()	Returns whether to add edited value.
void	onBuildCompletedWithValue(AbstractBuild<?,?> build, ExtensibleChoiceParameterDefinition def, String value)	Called when a build is completed Call addEditedValue() if needed
void	onBuildTriggeredWithValue(AbstractProject<?,?> job, ExtensibleChoiceParameterDefinition def, String value)	Called when a build is triggered Call addEditedValue() if needed

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

all, getChoiceList, getDefaultChoice, requiresBuildPermission

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

AddEditedChoiceListProvider

public AddEditedChoiceListProvider(boolean addEditedValue,
                                   AddEditedChoiceListProvider.WhenToAdd whenToAdd)

Constructor

Parameters:

whenToAdd - when to add a edited value.

Method Detail

getWhenToAdd

public AddEditedChoiceListProvider.WhenToAdd getWhenToAdd()

Returns when to add a edited value. null stands for no adding.

Returns:

when to add a edited value

isAddEditedValue

public boolean isAddEditedValue()

Returns whether to add edited value.

Returns:

whether to add edited value

onBuildCompletedWithValue

public void onBuildCompletedWithValue(AbstractBuild<?,?> build,
                                      ExtensibleChoiceParameterDefinition def,
                                      String value)

Called when a build is completed Call addEditedValue() if needed

Overrides:

onBuildCompletedWithValue in class ChoiceListProvider

Parameters:

build - the build with which this choice provider is used.

def - the parameter definition the value specified

value - the value specified.

See Also:

ChoiceListProvider.onBuildCompletedWithValue(hudson.model.AbstractBuild, jp.ikedam.jenkins.plugins.extensible_choice_parameter.ExtensibleChoiceParameterDefinition, java.lang.String)

onBuildTriggeredWithValue

public void onBuildTriggeredWithValue(AbstractProject<?,?> job,
                                      ExtensibleChoiceParameterDefinition def,
                                      String value)

Called when a build is triggered Call addEditedValue() if needed

Overrides:

onBuildTriggeredWithValue in class ChoiceListProvider

Parameters:

job - the job with which this choice provider is used.

def - the parameter definition the value specified

value - the value specified.

See Also:

ChoiceListProvider.onBuildTriggeredWithValue(hudson.model.AbstractProject, jp.ikedam.jenkins.plugins.extensible_choice_parameter.ExtensibleChoiceParameterDefinition, java.lang.String)

addEditedValue

protected abstract void addEditedValue(AbstractProject<?,?> project,
                                       ExtensibleChoiceParameterDefinition def,
                                       String value)

Called to add a edited value to the choice list.

Parameters:

project -

def -

value -