File D:\maven-qcr-plugin-testsunitaires\qcr4java\jenkins-master\target\site\qc\core\src\main\java\hudson\model\StringParameterDefinition.java.html

1 /*
2 * The MIT License
3 *
4 * Copyright (c) 2004-2009, Sun Microsystems, Inc., Kohsuke Kawaguchi, Luca Domenico Milanesio, Seiji Sogabe, Tom Huybrechts
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
24 package hudson.model;
25
26 import hudson.Extension;
27 import net.sf.json.JSONObject;
28 import org.kohsuke.stapler.DataBoundConstructor;
29 import org.kohsuke.stapler.StaplerRequest;
30
31 /**
32 * Parameter whose value is a string value.
33 */
34 public class StringParameterDefinition extends SimpleParameterDefinition {
35
36 private String defaultValue;
37
38 @DataBoundConstructor
39 public StringParameterDefinition(String name, String defaultValue, String description) {
40 super(name, description);
41 this.defaultValue = defaultValue;
42 }
43
44 public StringParameterDefinition(String name, String defaultValue) {
45 this(name, defaultValue, null);
46 }
47
48 @Override
49 public ParameterDefinition copyWithDefaultValue(ParameterValue defaultValue) {
50 if (defaultValue instanceof StringParameterValue) {
51 StringParameterValue value = (StringParameterValue) defaultValue;
52 return new StringParameterDefinition(getName(), value.value, getDescription());
53 } else {
54 return this;
55 }
56 }
57
58 public String getDefaultValue() {
59 return defaultValue;
60 }
61
62 public void setDefaultValue(String defaultValue) {
63 this.defaultValue = defaultValue;
64 }
65
66 @Override
67 public StringParameterValue getDefaultParameterValue() {
68 StringParameterValue v = new StringParameterValue(getName(), defaultValue, getDescription());
69 return v;
70 }
71
72 @Extension
73 public static class DescriptorImpl extends ParameterDescriptor {
74 @Override
75 public String getDisplayName() {
76 return Messages.StringParameterDefinition_DisplayName();
77 }
78
79 @Override
80 public String getHelpFile() {
81 return "/help/parameter/string.html";
82 }
83 }
84
85 @Override
86 public ParameterValue createValue(StaplerRequest req, JSONObject jo) {
87 StringParameterValue value = req.bindJSON(StringParameterValue.class, jo);
88 value.setDescription(getDescription());
89 return value;
90 }
91
92 public ParameterValue createValue(String value) {
93 return new StringParameterValue(getName(), value, getDescription());
94 }
95 }
96