Merge branch 'mmw/JAL-4199-web-services-testing' into development/Release_2_12_Branch
[jalview.git] / src / jalview / ws / params / simple / BooleanOption.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
4  * 
5  * This file is part of Jalview.
6  * 
7  * Jalview is free software: you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License 
9  * as published by the Free Software Foundation, either version 3
10  * of the License, or (at your option) any later version.
11  *  
12  * Jalview is distributed in the hope that it will be useful, but 
13  * WITHOUT ANY WARRANTY; without even the implied warranty 
14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
15  * PURPOSE.  See the GNU General Public License for more details.
16  * 
17  * You should have received a copy of the GNU General Public License
18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
19  * The Jalview Authors are detailed in the 'AUTHORS' file.
20  */
21 package jalview.ws.params.simple;
22
23 import java.net.URL;
24 import java.util.Arrays;
25 import java.util.List;
26
27 public class BooleanOption extends Option
28 {
29   public static class Builder extends Option.Builder
30   {
31     private boolean defaultValue = false;
32
33     private boolean value = false;
34
35     private String reprValue = null;
36
37     public void setDefaultValue(Boolean defaultValue)
38     {
39       this.defaultValue = defaultValue != null ? defaultValue : false;
40     }
41
42     public void setValue(Boolean value)
43     {
44       this.value = value != null ? value : false;
45     }
46
47     public void setReprValue(String reprValue)
48     {
49       this.reprValue = reprValue;
50     }
51
52     @Override
53     public void setPossibleValues(List<String> possibleValues)
54     {
55       throw new UnsupportedOperationException("cannot set possible values for boolean");
56     }
57
58     @Override
59     public BooleanOption build()
60     {
61       return new BooleanOption(this);
62     }
63   }
64
65   public static Builder newBuilder()
66   {
67     return new Builder();
68   }
69
70   protected BooleanOption(Builder builder)
71   {
72     super(builder);
73     String reprValue = builder.reprValue != null ? builder.reprValue : name;
74     defvalue = builder.defaultValue ? reprValue : null;
75     value = builder.value ? reprValue : null;
76     possibleVals = List.of(reprValue);
77     displayVals = List.of(label);
78   }
79
80   public BooleanOption(String name, String descr, boolean required,
81       Boolean defVal, Boolean val, URL link)
82   {
83     super(name, descr, required, (defVal != null && defVal ? name : null),
84         (val != null && val ? name : null), Arrays.asList(name), link);
85   }
86
87   public BooleanOption(String name, String description, String label,
88       boolean isrequired, Boolean defValue, String reprValue, URL link)
89   {
90     super(name, description, label, isrequired,
91         defValue != null && defValue ? reprValue : null,
92         defValue != null && defValue ? reprValue : null,
93         Arrays.asList(reprValue), link);
94   }
95
96   public BooleanOption(String name, String description, String label,
97       boolean isrequired, Boolean defValue, URL link)
98   {
99     this(name, description, label, isrequired, defValue, String.valueOf(true), link);
100   }
101 }