com.bluersw

类 AgentParameterDefinition

java.lang.Object

hudson.model.ParameterDefinition

com.bluersw.AgentParameterDefinition

所有已实现的接口:

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

public class AgentParameterDefinition
extends hudson.model.ParameterDefinition
implements Comparable<AgentParameterDefinition>

作者:

sunweisheng Jenkins 构建参数：Agent服务器选择（Jenkins build parameters: Agent server selection）

另请参阅:

序列化表格

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	AgentParameterDefinition.DescriptorImpl 参数描述类，实现了与UI交互的方法。

从类继承的嵌套类/接口 hudson.model.ParameterDefinition

hudson.model.ParameterDefinition.ParameterDescriptor

从接口继承的嵌套类/接口 hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

字段概要

从类继承的字段 hudson.model.ParameterDefinition

LIST

构造器概要

构造器

构造器和说明
AgentParameterDefinition(String name, String defaultValue) 构造函数在构建项目配置构建参数时调用（The constructor is called when the build project configures build parameter）

方法概要

限定符和类型	方法和说明
int	compareTo(AgentParameterDefinition o)
hudson.model.ParameterValue	createValue(hudson.cli.CLICommand command, String value) 创建Agent服务器参数的参数结果对象（Create parameter result object for Agent server parameter）
hudson.model.ParameterValue	createValue(org.kohsuke.stapler.StaplerRequest staplerRequest) 创建Agent服务器参数的参数结果对象（Create parameter result object for Agent server parameter）
hudson.model.ParameterValue	createValue(org.kohsuke.stapler.StaplerRequest staplerRequest, net.sf.json.JSONObject jsonObject) 创建Agent服务器参数的参数结果对象（Create parameter result object for Agent server parameter）
List<String>	getComputerNames() 获取所有Agent Server的显示名称（Get the display names of all Agent Servers）
hudson.model.ParameterValue	getDefaultParameterValue() 创建含有默认值的结果对象 （Create a result object with default values）
String	getDefaultValue() 获取构建参数默认值 （Get default values of build parameter）
AgentParameterDefinition.DescriptorImpl	getDescriptor() 获得构建参数描述对象，除了属性值绑定之外，与UI交互的动作方法在此对象内实现（Obtain the build parameter description object.
String	getDivId() 防止项目中有多个Agent Server Parameter，为每个构建参数的DIV元素创建唯一的ID值（Prevent multiple Agent Server Parameter in the project, create a unique ID value for each DIV element of the build parameter）
void	setDefaultValue(String defaultValue) 设置构建参数默认值 （Set default values for build parameter）

从类继承的方法 hudson.model.ParameterDefinition

all, copyWithDefaultValue, getDescription, getFormattedDescription, getName, getType

从类继承的方法 java.lang.Object

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

构造器详细资料

AgentParameterDefinition

@DataBoundConstructor
public AgentParameterDefinition(String name,
                                                      String defaultValue)

构造函数在构建项目配置构建参数时调用（The constructor is called when the build project configures build parameter）

参数:

name - 构建参数名称 （Build parameter name）

defaultValue - 该构建参数的默认值，会随着每次用户选择Agent服务器而改变（The default value of this build parameter will change each time the user selects the Agent server）

方法详细资料

getDefaultValue

public String getDefaultValue()

获取构建参数默认值 （Get default values of build parameter）

返回:

构建参数默认值 （Build parameter default value）

setDefaultValue

@DataBoundSetter
public void setDefaultValue(String defaultValue)

设置构建参数默认值 （Set default values for build parameter）

参数:

defaultValue - 要设置的构建参数默认值 （The default value of the build parameter to be set）

getDivId

public String getDivId()

防止项目中有多个Agent Server Parameter，为每个构建参数的DIV元素创建唯一的ID值（Prevent multiple Agent Server Parameter in the project, create a unique ID value for each DIV element of the build parameter）

返回:

DIV唯一ID（DIV unique ID）

createValue

@CheckForNull
public hudson.model.ParameterValue createValue(org.kohsuke.stapler.StaplerRequest staplerRequest,
                                                             net.sf.json.JSONObject jsonObject)

创建Agent服务器参数的参数结果对象（Create parameter result object for Agent server parameter）

指定者:

createValue 在类中 hudson.model.ParameterDefinition

参数:

staplerRequest - StaplerRequest对象（StaplerRequest object）

jsonObject - Agent服务器参数的结果对象，Json格式（Agent Server Parameter result object, Json format）

返回:

参数结果对象 （Parameter result object）

createValue

@CheckForNull
public hudson.model.ParameterValue createValue(org.kohsuke.stapler.StaplerRequest staplerRequest)

创建Agent服务器参数的参数结果对象（Create parameter result object for Agent server parameter）

指定者:

createValue 在类中 hudson.model.ParameterDefinition

参数:

staplerRequest - StaplerRequest对象（StaplerRequest object）

返回:

参数结果对象 （Parameter result object）

createValue

public hudson.model.ParameterValue createValue(hudson.cli.CLICommand command,
                                               String value)

创建Agent服务器参数的参数结果对象（Create parameter result object for Agent server parameter）

覆盖:

createValue 在类中 hudson.model.ParameterDefinition

参数:

command - CLICommand Object

value - Agent服务器参数的结果对象，字符串格式（Agent Server Parameter result object, String format）

返回:

参数结果对象 （Parameter result object）

getDefaultParameterValue

public hudson.model.ParameterValue getDefaultParameterValue()

创建含有默认值的结果对象 （Create a result object with default values）

覆盖:

getDefaultParameterValue 在类中 hudson.model.ParameterDefinition

返回:

默认的参数结果对象 （Default parameter result object）

compareTo

public int compareTo(AgentParameterDefinition o)

指定者:

compareTo 在接口中 Comparable<AgentParameterDefinition>

getComputerNames

public List<String> getComputerNames()

获取所有Agent Server的显示名称（Get the display names of all Agent Servers）

返回:

Agent Server的显示名称列表（List of display names of Agent Server）

getDescriptor

public AgentParameterDefinition.DescriptorImpl getDescriptor()

获得构建参数描述对象，除了属性值绑定之外，与UI交互的动作方法在此对象内实现（Obtain the build parameter description object. In addition to the attribute value binding, the action method for interacting with the UI is implemented in this object）

指定者:

getDescriptor 在接口中 hudson.model.Describable<hudson.model.ParameterDefinition>

覆盖:

getDescriptor 在类中 hudson.model.ParameterDefinition

返回:

构建参数对象描述对象（Build parameter object description object）