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

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

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

hudson.model.Describable<GlobalTextareaChoiceListEntry>, Serializable

public class GlobalTextareaChoiceListEntry
extends hudson.model.AbstractDescribableImpl<GlobalTextareaChoiceListEntry>
implements Serializable

A set of choices that can be used in Global Choice Parameter. Holds a name and a list of choices. Added in the System Configuration page.

関連項目:

直列化された形式

入れ子のクラスの概要

static class

GlobalTextareaChoiceListEntry.DescriptorImpl The internal class to work with views.

コンストラクタの概要

GlobalTextareaChoiceListEntry(String name, String choiceListText, boolean allowAddEditedValue)
Constructor instantiating with parameters in the configuration page.

メソッドの概要

void	addEditedValue(String value)
boolean	equals(Object o)
List<String>	getChoiceList() The list of choices.
String	getChoiceListText() The list of choices, joined into a string.
String	getName() the name of this set of choices.
static Pattern	getNamePattern()
boolean	isAllowAddEditedValue() Return whether users can add a new value by building a job using this choice list.
boolean	isValid() Returns whether this object is configured correctly.
protected void	setChoiceList(List<String> choiceList) Set choiceList
String	toString()

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

getDescriptor

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

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

コンストラクタの詳細

GlobalTextareaChoiceListEntry

@DataBoundConstructor
public GlobalTextareaChoiceListEntry(String name,
                                                          String choiceListText,
                                                          boolean allowAddEditedValue)

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 set of choices.

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

allowAddEditedValue - whether users can add a new value by building a job using this choice list.

メソッドの詳細

getNamePattern

public static Pattern getNamePattern()

戻り値:

A regular expression pattern for the acceptable names.

getName

public String getName()

the name of this set of choices.

戻り値:

the name the user specified.

getChoiceList

public List<String> getChoiceList()

The list of choices.

戻り値:

the list of choices the user specified.

getChoiceListText

public String getChoiceListText()

The list of choices, joined into a string. Used for filling a field when the configuration page is shown. The newline code is appended also after the last element.

戻り値:

Joined choices.

setChoiceList

protected void setChoiceList(List<String> choiceList)

Set choiceList

パラメータ:

choiceList - the choiceList to set

isAllowAddEditedValue

public boolean isAllowAddEditedValue()

Return whether users can add a new value by building a job using this choice list.

戻り値:

the allowAddEditedValue

isValid

public boolean isValid()

Returns whether this object is configured correctly. Jenkins framework seems to accept the values that doCheckXXX alerts an error. Throwing a exception from the constructor annotated with DataBoundConstructor results in an exception page, so I decided to omit bad objects with this method.

戻り値:

whether this object is configured correctly.

addEditedValue

public void addEditedValue(String value)

パラメータ:

value -

equals

public boolean equals(Object o)

オーバーライド:

クラス Object 内の equals

パラメータ:

o -

戻り値:

関連項目:

Object.equals(java.lang.Object)

toString

public String toString()

オーバーライド:

クラス Object 内の toString

戻り値:

関連項目:

Object.toString()