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

1 /*
2 * The MIT License
3 *
4 * Copyright (c) 2004-2009, Sun Microsystems, Inc.
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 org.kohsuke.stapler.StaplerRequest;
27 import org.kohsuke.stapler.DataBoundConstructor;
28 import net.sf.json.JSONObject;
29 import hudson.Extension;
30
31 /**
32 * {@link ParameterDefinition} that is either 'true' or 'false'.
33 *
34 * @author huybrechts
35 */
36 public class BooleanParameterDefinition extends SimpleParameterDefinition {
37 private final boolean defaultValue;
38
39 @DataBoundConstructor
40 public BooleanParameterDefinition(String name, boolean defaultValue, String description) {
41 super(name, description);
42 this.defaultValue = defaultValue;
43 }
44
45 @Override
46 public ParameterDefinition copyWithDefaultValue(ParameterValue defaultValue) {
47 if (defaultValue instanceof BooleanParameterValue) {
48 BooleanParameterValue value = (BooleanParameterValue) defaultValue;
49 return new BooleanParameterDefinition(getName(), value.value, getDescription());
50 } else {
51 return this;
52 }
53 }
54
55 public boolean isDefaultValue() {
56 return defaultValue;
57 }
58
59 @Override
60 public ParameterValue createValue(StaplerRequest req, JSONObject jo) {
61 BooleanParameterValue value = req.bindJSON(BooleanParameterValue.class, jo);
62 value.setDescription(getDescription());
63 return value;
64 }
65
66 public ParameterValue createValue(String value) {
67 return new BooleanParameterValue(getName(),Boolean.valueOf(value),getDescription());
68 }
69
70 @Override
71 public BooleanParameterValue getDefaultParameterValue() {
72 return new BooleanParameterValue(getName(), defaultValue, getDescription());
73 }
74
75 @Extension
76 public static class DescriptorImpl extends ParameterDescriptor {
77 @Override
78 public String getDisplayName() {
79 return Messages.BooleanParameterDefinition_DisplayName();
80 }
81
82 @Override
83 public String getHelpFile() {
84 return "/help/parameter/boolean.html";
85 }
86 }
87
88 }
89