com.bluersw

类 AgentParameterDefinition.DescriptorImpl

java.lang.Object

hudson.model.Descriptor<hudson.model.ParameterDefinition>

hudson.model.ParameterDefinition.ParameterDescriptor

com.bluersw.AgentParameterDefinition.DescriptorImpl

所有已实现的接口:

hudson.model.Saveable, jenkins.util.io.OnMaster

封闭类:

AgentParameterDefinition

@Symbol(value="agentParameter")
 @Extension
public static class AgentParameterDefinition.DescriptorImpl
extends hudson.model.ParameterDefinition.ParameterDescriptor

参数描述类，实现了与UI交互的方法。（The parameter description class implements the method of interacting with the UI.）

嵌套类概要

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

hudson.model.Descriptor.FormException, hudson.model.Descriptor.PropertyType, hudson.model.Descriptor.Self

字段概要

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

clazz

从接口继承的字段 hudson.model.Saveable

NOOP

构造器概要

构造器

构造器和说明
DescriptorImpl()

方法概要

限定符和类型	方法和说明
hudson.util.FormValidation	doCheckName(String name) 验证用户输入的参数名称是否合法，注意一定是“doCheck”+“要检查的参数名称”形式为方法名称。
hudson.util.ListBoxModel	doFillValueItems(hudson.model.Job job, String name) 在项目构建页面设置参数时调用，将所有可以用于构建的服务器名称，绑定到下拉菜单中让用户选择，方法名称必须是"doFill"+要绑定数据的页面元素field属性值+"Items"。
String	doSetDefaultValue(hudson.model.Job job, String name, String value) 客户端选择Agent服务器时JS脚本调用的服务器端方法，作用是更新此参数的默认值，以便于方便用户下次项目构建时不需要再次选择Agent服务器。
String	getDisplayName() 在项目配置界面显示此构建参数的名称
hudson.model.ParameterDefinition	newInstance(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject formData)

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

getValuePage

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

addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, configure, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

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

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

构造器详细资料

DescriptorImpl

public DescriptorImpl()

方法详细资料

doCheckName

public hudson.util.FormValidation doCheckName(@QueryParameter
                                              String name)

验证用户输入的参数名称是否合法，注意一定是“doCheck”+“要检查的参数名称”形式为方法名称。（Verify that the parameter name entered by the user is legal. Note that it must be in the form of "doCheck" + "parameter name to be checked" as the method name.）

参数:

name - 要检查的Name内容。（Name content to check.）

返回:

检查是否通过，如果没有通过返回错误信息。（Check if it passes, and return an error message if it fails.）

getDisplayName

@NonNull
public String getDisplayName()

在项目配置界面显示此构建参数的名称

覆盖:

getDisplayName 在类中 hudson.model.ParameterDefinition.ParameterDescriptor

返回:

"Agent Server Parameter"

newInstance

public hudson.model.ParameterDefinition newInstance(@Nullable
                                                    org.kohsuke.stapler.StaplerRequest req,
                                                    @NonNull
                                                    net.sf.json.JSONObject formData)

覆盖:

newInstance 在类中 hudson.model.Descriptor<hudson.model.ParameterDefinition>

doSetDefaultValue

public String doSetDefaultValue(@AncestorInPath
                                hudson.model.Job job,
                                @QueryParameter
                                String name,
                                @QueryParameter
                                String value)

客户端选择Agent服务器时JS脚本调用的服务器端方法，作用是更新此参数的默认值，以便于方便用户下次项目构建时不需要再次选择Agent服务器。方法名一定是"do"+"方法名"。（When the client selects the agent server, the server-side method called by the JS script is to update the default value of this parameter, so that the user does not need to select the agent server again when the project is built next time.The method name must be "do" + "method name".）

参数:

job - 当前项目的构建任务。（The build task of the current project.）

name - Agent Server Parameter的名称。（The name of the agent Server Parameter.）

value - 用户选择的Agent服务器的名称。（The name of the agent server selected by the user.）

返回:

操作结果说明。（Explanation of operation result.）

doFillValueItems

public hudson.util.ListBoxModel doFillValueItems(@AncestorInPath
                                                 hudson.model.Job job,
                                                 @QueryParameter
                                                 String name)

在项目构建页面设置参数时调用，将所有可以用于构建的服务器名称，绑定到下拉菜单中让用户选择，方法名称必须是"doFill"+要绑定数据的页面元素field属性值+"Items"。（Called when setting parameters on the project construction page, bind all server names that can be used for construction to the drop-down menu for the user to choose, the method name must be "doFill" + field attribute value of the page element to be bound data + "Items ".）

参数:

job - 当前项目的构建任务。（The build task of the current project.）

name - Agent Server Parameter的名称。（The name of the Agent Server Parameter.）

返回:

Agent名称列表是Select元素，返回此元素的内容。（The agent name list is the Select element, and returns the content of this element.）