jp.ikedam.jenkins.plugins.extensible_choice_parameter
クラス ChoiceListProvider

java.lang.Object
  hudson.model.AbstractDescribableImpl<ChoiceListProvider>
      jp.ikedam.jenkins.plugins.extensible_choice_parameter.ChoiceListProvider

すべての実装されたインタフェース:

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

直系の既知のサブクラス:

AddEditedChoiceListProvider, FilenameChoiceListProvider, SystemGroovyChoiceListProvider

public abstract class ChoiceListProvider
extends hudson.model.AbstractDescribableImpl<ChoiceListProvider>
implements hudson.ExtensionPoint

The abstract base class of modules provides choices. Create a new choice provider in following steps:

1. Define a new class derived from ChoiceListProvider
2. Override getChoiceList(), which returns the choices.
3. Define the internal public static class named DescriptorImpl, derived from Descriptor<ChoiceListProvider>
4. annotate the DescriptorImpl with Extension

入れ子のクラスの概要

インタフェース hudson.ExtensionPoint から継承された入れ子のクラス/インタフェース

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

コンストラクタの概要

ChoiceListProvider()

メソッドの概要

static hudson.DescriptorExtensionList<ChoiceListProvider,hudson.model.Descriptor<ChoiceListProvider>>	all() Returns all the ChoiceListProvider subclass whose DescriptorImpl is annotated with Extension.
abstract List<String>	getChoiceList() Returns the choices.
String	getDefaultChoice() Returns the default choice value.
void	onBuildCompletedWithValue(hudson.model.AbstractBuild<?,?> build, ExtensibleChoiceParameterDefinition def, String value) Called when a build is completed Implementations can override this method, and do custom behavior.
void	onBuildTriggeredWithValue(hudson.model.AbstractProject<?,?> job, ExtensibleChoiceParameterDefinition def, String value) Called when a build is triggered Implementations can override this method, and do custom behavior.

クラス hudson.model.AbstractDescribableImpl から継承されたメソッド

getDescriptor

クラス java.lang.Object から継承されたメソッド

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

コンストラクタの詳細

ChoiceListProvider

public ChoiceListProvider()

メソッドの詳細

getChoiceList

public abstract List<String> getChoiceList()

Returns the choices.

戻り値:

the choices list.

getDefaultChoice

public String getDefaultChoice()

Returns the default choice value. null indicates the first one is the default value.

戻り値:

the default choice value.

onBuildTriggeredWithValue

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

Called when a build is triggered Implementations can override this method, and do custom behavior. Default implementation do nothing at all.

パラメータ:

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

def - the parameter definition the value specified

value - the value specified.

onBuildCompletedWithValue

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

Called when a build is completed Implementations can override this method, and do custom behavior. Default implementation do nothing at all.

パラメータ:

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

def - the parameter definition the value specified

value - the value specified.

all

public static hudson.DescriptorExtensionList<ChoiceListProvider,hudson.model.Descriptor<ChoiceListProvider>> all()

Returns all the ChoiceListProvider subclass whose DescriptorImpl is annotated with Extension.

戻り値:

DescriptorExtensionList of ChoiceListProvider subclasses.