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

java.lang.Object
  hudson.model.ParameterDefinition
      hudson.model.SimpleParameterDefinition
          jp.ikedam.jenkins.plugins.extensible_choice_parameter.ExtensibleChoiceParameterDefinition

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

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

public class ExtensibleChoiceParameterDefinition
extends hudson.model.SimpleParameterDefinition

Provides a choice parameter whose choices can be extended using Extension Points.

関連項目:

直列化された形式

入れ子のクラスの概要

static class	ExtensibleChoiceParameterDefinition.DescriptorImpl The internal class to work with views.
static class	ExtensibleChoiceParameterDefinition.DescriptorVisibilityFilterImpl

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

hudson.model.ParameterDefinition.ParameterDescriptor

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

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

フィールドの概要

クラス hudson.model.ParameterDefinition から継承されたフィールド

LIST

コンストラクタの概要

ExtensibleChoiceParameterDefinition(String name, ChoiceListProvider choiceListProvider, boolean editable, String description)
Constructor instantiating with parameters in the configuration page.

メソッドの概要

hudson.model.ParameterValue	createValue(org.kohsuke.stapler.StaplerRequest request, net.sf.json.JSONObject jo) Decide a value of this parameter from the user input.
hudson.model.ParameterValue	createValue(String value) Decide a value of this parameter from the user input.
protected hudson.model.ParameterValue	createValueCommon(hudson.model.StringParameterValue value) Test passed ParameterValue and return.
List<String>	getChoiceList() Return choices available for this parameter.
ChoiceListProvider	getChoiceListProvider() The choice provider the user specified.
hudson.model.ParameterValue	getDefaultParameterValue() Returns the default value of this parameter.
ChoiceListProvider	getEnabledChoiceListProvider()
static Pattern	getNamePattern() 推奨されていません。
boolean	isEditable() Is this parameter value can be set to a value not in the choices?

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

createValue, createValue

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

all, copyWithDefaultValue, getDescription, getDescriptor, getName, getType

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

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

コンストラクタの詳細

ExtensibleChoiceParameterDefinition

@DataBoundConstructor
public ExtensibleChoiceParameterDefinition(String name,
                                                                ChoiceListProvider choiceListProvider,
                                                                boolean editable,
                                                                String description)

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.

パラメータ:

name - the name of this parameter (used as a variable name).

choiceListProvider - the choice provider

editable - whether this parameter can be a value not in choices.

description - the description of this parameter. Used only for the convenience of users.

メソッドの詳細

getNamePattern

@Deprecated
public static Pattern getNamePattern()

推奨されていません。

Deprecated

isEditable

public boolean isEditable()

Is this parameter value can be set to a value not in the choices?

戻り値:

whether this parameter is editable.

getChoiceListProvider

public ChoiceListProvider getChoiceListProvider()

The choice provider the user specified.

戻り値:

choice provider.

getEnabledChoiceListProvider

public ChoiceListProvider getEnabledChoiceListProvider()

戻り値:

choice provider only when it's enabled

関連項目:

ExtensibleChoiceParameterDefinition.DescriptorImpl.isProviderEnabled(Descriptor)

getChoiceList

public List<String> getChoiceList()

Return choices available for this parameter.

戻り値:

list of choices. never null.

createValueCommon

protected hudson.model.ParameterValue createValueCommon(hudson.model.StringParameterValue value)

Test passed ParameterValue and return. Common processing of createValue

パラメータ:

value - a value to test.

戻り値:

a value tested. same with value.

createValue

public hudson.model.ParameterValue createValue(org.kohsuke.stapler.StaplerRequest request,
                                               net.sf.json.JSONObject jo)

Decide a value of this parameter from the user input.

定義:

クラス hudson.model.ParameterDefinition 内の createValue

パラメータ:

request -

jo - the user input

戻り値:

the value of this parameter.

関連項目:

ParameterDefinition.createValue(org.kohsuke.stapler.StaplerRequest, net.sf.json.JSONObject)

createValue

public hudson.model.ParameterValue createValue(String value)
                                        throws IllegalArgumentException

Decide a value of this parameter from the user input.

定義:

クラス hudson.model.SimpleParameterDefinition 内の createValue

パラメータ:

value - the user input

戻り値:

the value of this parameter.

例外:

IllegalArgumentException - The value is not in choices even the field is not editable.

関連項目:

SimpleParameterDefinition.createValue(java.lang.String)

getDefaultParameterValue

public hudson.model.ParameterValue getDefaultParameterValue()

Returns the default value of this parameter. If not specified by the provider, the first value in the choice is used. returns null if no choice list is defined.

オーバーライド:

クラス hudson.model.ParameterDefinition 内の getDefaultParameterValue

戻り値:

the default value of this parameter.

関連項目:

ParameterDefinition.getDefaultParameterValue()