source: release-kits/lirk3/bin/ant-installer/web/java2html/antinstaller/org/tp23/antinstaller/input/OutputField.java.html@ 14982

Last change on this file since 14982 was 14982, checked in by oranfry, 16 years ago

initial import of LiRK3
File size: 15.2 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
2<HTML>
3<HEAD>
4<LINK REL=STYLESHEET TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
5<META NAME="GENERATOR" CONTENT="Java2HTML Version 1.4">
6<TITLE>org.tp23.antinstaller.input.OutputField (Java2HTML)</TITLE>
7</HEAD>
8<BODY><TABLE id="Header" border="0" cellpadding="0" cellspacing="0" width="100%">
9<tr>
10<td colspan="2" width="33%">&nbsp;</td>
11<td align="center" colspan="2" width="33%">
12<font size="4" class="ClassName">OutputField.java</font>
13</td>
14<td align="right" colspan="2" width="33%">&nbsp;</td>
15</tr>
16</TABLE>
17<pre CLASS="Classes">
18<FONT CLASS="LN">1 </FONT><A NAME="1"></A><FONT CLASS="MultiLineComment">/*
19<FONT CLASS="LN">2 </FONT><A NAME="2"></A> * Copyright 2005 Paul Hinds
20<FONT CLASS="LN">3 </FONT><A NAME="3"></A> *
21<FONT CLASS="LN">4 </FONT><A NAME="4"></A> * Licensed under the Apache License, Version 2.0 (the "License");
22<FONT CLASS="LN">5 </FONT><A NAME="5"></A> * you may not use this file except in compliance with the License.
23<FONT CLASS="LN">6 </FONT><A NAME="6"></A> * You may obtain a copy of the License at
24<FONT CLASS="LN">7 </FONT><A NAME="7"></A> *
25<FONT CLASS="LN">8 </FONT><A NAME="8"></A> * http://www.apache.org/licenses/LICENSE-2.0
26<FONT CLASS="LN">9 </FONT><A NAME="9"></A> *
27<FONT CLASS="LN">10</FONT><A NAME="10"></A> * Unless required by applicable law or agreed to in writing, software
28<FONT CLASS="LN">11</FONT><A NAME="11"></A> * distributed under the License is distributed on an "AS IS" BASIS,
29<FONT CLASS="LN">12</FONT><A NAME="12"></A> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
30<FONT CLASS="LN">13</FONT><A NAME="13"></A> * See the License for the specific language governing permissions and
31<FONT CLASS="LN">14</FONT><A NAME="14"></A> * limitations under the License.
32<FONT CLASS="LN">15</FONT><A NAME="15"></A> */</FONT>
33<FONT CLASS="LN">16</FONT><A NAME="16"></A><FONT CLASS="Package">package</FONT> <A HREF="../../../../org.tp23.antinstaller.input.index.html" target="packageFrame">org.tp23.antinstaller.input</A>;
34<FONT CLASS="LN">17</FONT><A NAME="17"></A>
35<FONT CLASS="LN">18</FONT><A NAME="18"></A><FONT CLASS="Import">import</FONT> java.util.MissingResourceException;
36<FONT CLASS="LN">19</FONT><A NAME="19"></A><FONT CLASS="Import">import</FONT> java.util.ResourceBundle;
37<FONT CLASS="LN">20</FONT><A NAME="20"></A>
38<FONT CLASS="LN">21</FONT><A NAME="21"></A><FONT CLASS="Import">import</FONT> <A HREF="../../../../org/tp23/antinstaller/InstallerContext.java.html">org.tp23.antinstaller.InstallerContext</A>;
39<FONT CLASS="LN">22</FONT><A NAME="22"></A><FONT CLASS="Import">import</FONT> <A HREF="../../../../org/tp23/antinstaller/ValidationException.java.html">org.tp23.antinstaller.ValidationException</A>;
40<FONT CLASS="LN">23</FONT><A NAME="23"></A><FONT CLASS="FormalComment">/**
41<FONT CLASS="LN">24</FONT><A NAME="24"></A> * This is the super class of all "Input types". It is called OutputField since
42<FONT CLASS="LN">25</FONT><A NAME="25"></A> * it handles the base features of "Input types" for outputing text for
43<FONT CLASS="LN">26</FONT><A NAME="26"></A> * the user to read. It also encapsulates some convenience methods for
44<FONT CLASS="LN">27</FONT><A NAME="27"></A> * interpreting boolean values from the command line and in configuration files.
45<FONT CLASS="LN">28</FONT><A NAME="28"></A> */</FONT>
46<FONT CLASS="LN">29</FONT><A NAME="29"></A><FONT CLASS="Public">public</FONT> <FONT CLASS="Abstract">abstract</FONT> <FONT CLASS="Class">class</FONT> OutputField {
47<FONT CLASS="LN">30</FONT><A NAME="30"></A>
48<FONT CLASS="LN">31</FONT><A NAME="31"></A> <FONT CLASS="SingleLineComment">// i18n support
49<FONT CLASS="LN">32</FONT><A NAME="32"></A></FONT> <FONT CLASS="Private">private</FONT> <FONT CLASS="Static">static</FONT> ResourceBundle langPack = <FONT CLASS="Null">null</FONT>;
50<FONT CLASS="LN">33</FONT><A NAME="33"></A> <FONT CLASS="Private">private</FONT> <FONT CLASS="Static">static</FONT> <FONT CLASS="Int">int</FONT> commentIdx = <FONT CLASS="IntegerLiteral">0</FONT>;
51<FONT CLASS="LN">34</FONT><A NAME="34"></A> <FONT CLASS="Static">static</FONT>{
52<FONT CLASS="LN">35</FONT><A NAME="35"></A> <FONT CLASS="Try">try</FONT> {
53<FONT CLASS="LN">36</FONT><A NAME="36"></A> langPack = ResourceBundle.getBundle(<FONT CLASS="StringLiteral">"resources.LanguagePack"</FONT>);
54<FONT CLASS="LN">37</FONT><A NAME="37"></A> } <FONT CLASS="Catch">catch</FONT> (MissingResourceException e) {
55<FONT CLASS="LN">38</FONT><A NAME="38"></A> <FONT CLASS="SingleLineComment">// ignore, signifies no lang packs installed
56<FONT CLASS="LN">39</FONT><A NAME="39"></A></FONT> }
57<FONT CLASS="LN">40</FONT><A NAME="40"></A> }
58<FONT CLASS="LN">41</FONT><A NAME="41"></A>
59<FONT CLASS="LN">42</FONT><A NAME="42"></A> <FONT CLASS="MultiLineComment">/* This is redundant unless language packs are used
60<FONT CLASS="LN">43</FONT><A NAME="43"></A> */</FONT>
61<FONT CLASS="LN">44</FONT><A NAME="44"></A> <FONT CLASS="Private">private</FONT> String name = <FONT CLASS="StringLiteral">"comment."</FONT> + ++commentIdx;
62<FONT CLASS="LN">45</FONT><A NAME="45"></A>
63<FONT CLASS="LN">46</FONT><A NAME="46"></A> <FONT CLASS="Protected">protected</FONT> String displayText;
64<FONT CLASS="LN">47</FONT><A NAME="47"></A> <FONT CLASS="Protected">protected</FONT> String explanatoryText;
65<FONT CLASS="LN">48</FONT><A NAME="48"></A> <FONT CLASS="Protected">protected</FONT> <A HREF="../../../../org/tp23/antinstaller/input/ResultContainer.java.html">ResultContainer</A> resultContainer;
66<FONT CLASS="LN">49</FONT><A NAME="49"></A>
67<FONT CLASS="LN">50</FONT><A NAME="50"></A> <FONT CLASS="Public">public</FONT> OutputField() {
68<FONT CLASS="LN">51</FONT><A NAME="51"></A>
69<FONT CLASS="LN">52</FONT><A NAME="52"></A> }
70<FONT CLASS="LN">53</FONT><A NAME="53"></A>
71<FONT CLASS="LN">54</FONT><A NAME="54"></A> <FONT CLASS="MultiLineComment">/* This is redundant unless language packs are used
72<FONT CLASS="LN">55</FONT><A NAME="55"></A> */</FONT>
73<FONT CLASS="LN">56</FONT><A NAME="56"></A> <FONT CLASS="Public">public</FONT> String getName() {
74<FONT CLASS="LN">57</FONT><A NAME="57"></A> <FONT CLASS="Return">return</FONT> name;
75<FONT CLASS="LN">58</FONT><A NAME="58"></A> }
76<FONT CLASS="LN">59</FONT><A NAME="59"></A>
77<FONT CLASS="LN">60</FONT><A NAME="60"></A> <FONT CLASS="MultiLineComment">/* This is redundant unless language packs are used
78<FONT CLASS="LN">61</FONT><A NAME="61"></A> */</FONT>
79<FONT CLASS="LN">62</FONT><A NAME="62"></A> <FONT CLASS="Public">public</FONT> <FONT CLASS="Void">void</FONT> setName(String name) {
80<FONT CLASS="LN">63</FONT><A NAME="63"></A> <FONT CLASS="This">this</FONT>.name = name;
81<FONT CLASS="LN">64</FONT><A NAME="64"></A> }
82<FONT CLASS="LN">65</FONT><A NAME="65"></A>
83<FONT CLASS="LN">66</FONT><A NAME="66"></A> <FONT CLASS="Public">public</FONT> String getDisplayText() {
84<FONT CLASS="LN">67</FONT><A NAME="67"></A> <FONT CLASS="If">if</FONT>(langPack != <FONT CLASS="Null">null</FONT>){
85<FONT CLASS="LN">68</FONT><A NAME="68"></A> <FONT CLASS="Return">return</FONT> langPack.getString(getName() + <FONT CLASS="StringLiteral">".displayText"</FONT>);
86<FONT CLASS="LN">69</FONT><A NAME="69"></A> }
87<FONT CLASS="LN">70</FONT><A NAME="70"></A> <FONT CLASS="Return">return</FONT> displayText;
88<FONT CLASS="LN">71</FONT><A NAME="71"></A> }
89<FONT CLASS="LN">72</FONT><A NAME="72"></A>
90<FONT CLASS="LN">73</FONT><A NAME="73"></A> <FONT CLASS="Public">public</FONT> <FONT CLASS="Void">void</FONT> setDisplayText(String displayText) {
91<FONT CLASS="LN">74</FONT><A NAME="74"></A> <FONT CLASS="This">this</FONT>.displayText = displayText;
92<FONT CLASS="LN">75</FONT><A NAME="75"></A> }
93<FONT CLASS="LN">76</FONT><A NAME="76"></A>
94<FONT CLASS="LN">77</FONT><A NAME="77"></A> <FONT CLASS="Public">public</FONT> String getExplanatoryText() {
95<FONT CLASS="LN">78</FONT><A NAME="78"></A> <FONT CLASS="If">if</FONT>(langPack != <FONT CLASS="Null">null</FONT>){
96<FONT CLASS="LN">79</FONT><A NAME="79"></A> <FONT CLASS="Try">try</FONT> {
97<FONT CLASS="LN">80</FONT><A NAME="80"></A> <FONT CLASS="Return">return</FONT> langPack.getString(getName() + <FONT CLASS="StringLiteral">".explanatoryText"</FONT>);
98<FONT CLASS="LN">81</FONT><A NAME="81"></A> } <FONT CLASS="Catch">catch</FONT> (MissingResourceException e) {
99<FONT CLASS="LN">82</FONT><A NAME="82"></A> <FONT CLASS="SingleLineComment">// ignore and return null explanatoryText is optional
100<FONT CLASS="LN">83</FONT><A NAME="83"></A></FONT> }
101<FONT CLASS="LN">84</FONT><A NAME="84"></A> }
102<FONT CLASS="LN">85</FONT><A NAME="85"></A> <FONT CLASS="Return">return</FONT> explanatoryText;
103<FONT CLASS="LN">86</FONT><A NAME="86"></A> }
104<FONT CLASS="LN">87</FONT><A NAME="87"></A>
105<FONT CLASS="LN">88</FONT><A NAME="88"></A> <FONT CLASS="Public">public</FONT> <FONT CLASS="Void">void</FONT> setExplanatoryText(String explanatoryText) {
106<FONT CLASS="LN">89</FONT><A NAME="89"></A> <FONT CLASS="This">this</FONT>.explanatoryText = explanatoryText;
107<FONT CLASS="LN">90</FONT><A NAME="90"></A> }
108<FONT CLASS="LN">91</FONT><A NAME="91"></A>
109<FONT CLASS="LN">92</FONT><A NAME="92"></A> <FONT CLASS="Public">public</FONT> <FONT CLASS="Void">void</FONT> setResultContainer(<A HREF="../../../../org/tp23/antinstaller/input/ResultContainer.java.html">ResultContainer</A> resultContainer) {
110<FONT CLASS="LN">93</FONT><A NAME="93"></A> <FONT CLASS="This">this</FONT>.resultContainer = resultContainer;
111<FONT CLASS="LN">94</FONT><A NAME="94"></A> }
112<FONT CLASS="LN">95</FONT><A NAME="95"></A>
113<FONT CLASS="LN">96</FONT><A NAME="96"></A> <FONT CLASS="FormalComment">/**
114<FONT CLASS="LN">97</FONT><A NAME="97"></A> * Validate the user input (or lack of it)
115<FONT CLASS="LN">98</FONT><A NAME="98"></A> * This method should return false if the validation fails an throw an exception
116<FONT CLASS="LN">99</FONT><A NAME="99"></A> * if it is not possible to validate or there is an error.
117<FONT CLASS="LN">00</FONT><A NAME="100"></A> *
118<FONT CLASS="LN">01</FONT><A NAME="101"></A> * @param cxt InstallerContext
119<FONT CLASS="LN">02</FONT><A NAME="102"></A> * @throws ValidationException thrown in error conditions not validation failure
120<FONT CLASS="LN">03</FONT><A NAME="103"></A> * @return boolean
121<FONT CLASS="LN">04</FONT><A NAME="104"></A> */</FONT>
122<FONT CLASS="LN">05</FONT><A NAME="105"></A> <FONT CLASS="Public">public</FONT> <FONT CLASS="Abstract">abstract</FONT> <FONT CLASS="Boolean">boolean</FONT> validate(<A HREF="../../../../org/tp23/antinstaller/InstallerContext.java.html">InstallerContext</A> cxt) <FONT CLASS="Throws">throws</FONT> <A HREF="../../../../org/tp23/antinstaller/ValidationException.java.html">ValidationException</A>;
123<FONT CLASS="LN">06</FONT><A NAME="106"></A>
124<FONT CLASS="LN">07</FONT><A NAME="107"></A> <FONT CLASS="FormalComment">/**
125<FONT CLASS="LN">08</FONT><A NAME="108"></A> * Used to validate the configuration, this can be run prior to distributing the
126<FONT CLASS="LN">09</FONT><A NAME="109"></A> * installer to check that the config is valid. Will not be used at runtime.
127<FONT CLASS="LN">10</FONT><A NAME="110"></A> * @throws ValidationException
128<FONT CLASS="LN">11</FONT><A NAME="111"></A> * @return boolean
129<FONT CLASS="LN">12</FONT><A NAME="112"></A> */</FONT>
130<FONT CLASS="LN">13</FONT><A NAME="113"></A> <FONT CLASS="Public">public</FONT> <FONT CLASS="Abstract">abstract</FONT> <FONT CLASS="Boolean">boolean</FONT> validateObject();
131<FONT CLASS="LN">14</FONT><A NAME="114"></A>
132<FONT CLASS="LN">15</FONT><A NAME="115"></A> <FONT CLASS="SingleLineComment">//////////////////////Static convenience methods
133<FONT CLASS="LN">16</FONT><A NAME="116"></A></FONT>
134<FONT CLASS="LN">17</FONT><A NAME="117"></A> <FONT CLASS="FormalComment">/** true if specified and true or yes.
135<FONT CLASS="LN">18</FONT><A NAME="118"></A> * N.B it is possible for X, isTrue(X) == isFalse(X);
136<FONT CLASS="LN">19</FONT><A NAME="119"></A> * This occurs if the value is null.
137<FONT CLASS="LN">20</FONT><A NAME="120"></A> */</FONT>
138<FONT CLASS="LN">21</FONT><A NAME="121"></A> <FONT CLASS="Public">public</FONT> <FONT CLASS="Static">static</FONT> <FONT CLASS="Boolean">boolean</FONT> isTrue(String value){
139<FONT CLASS="LN">22</FONT><A NAME="122"></A> <FONT CLASS="If">if</FONT>(value == <FONT CLASS="Null">null</FONT>)<FONT CLASS="Return">return</FONT> <FONT CLASS="False">false</FONT>;
140<FONT CLASS="LN">23</FONT><A NAME="123"></A> <FONT CLASS="Return">return</FONT> value.equalsIgnoreCase(<FONT CLASS="StringLiteral">"true"</FONT>) || value.equalsIgnoreCase(<FONT CLASS="StringLiteral">"yes"</FONT>);
141<FONT CLASS="LN">24</FONT><A NAME="124"></A> }
142<FONT CLASS="LN">25</FONT><A NAME="125"></A> <FONT CLASS="FormalComment">/** same as isTrue() but default is false if not specified */</FONT>
143<FONT CLASS="LN">26</FONT><A NAME="126"></A> <FONT CLASS="Public">public</FONT> <FONT CLASS="Static">static</FONT> <FONT CLASS="Boolean">boolean</FONT> isFalse(String value){
144<FONT CLASS="LN">27</FONT><A NAME="127"></A> <FONT CLASS="If">if</FONT>(value == <FONT CLASS="Null">null</FONT>)<FONT CLASS="Return">return</FONT> <FONT CLASS="False">false</FONT>;
145<FONT CLASS="LN">28</FONT><A NAME="128"></A> <FONT CLASS="Return">return</FONT> value.equalsIgnoreCase(<FONT CLASS="StringLiteral">"false"</FONT>) || value.equalsIgnoreCase(<FONT CLASS="StringLiteral">"no"</FONT>);
146<FONT CLASS="LN">29</FONT><A NAME="129"></A> }
147<FONT CLASS="LN">30</FONT><A NAME="130"></A> <FONT CLASS="FormalComment">/**
148<FONT CLASS="LN">31</FONT><A NAME="131"></A> * Return true if the value is set to true or false, returns false if the value is null
149<FONT CLASS="LN">32</FONT><A NAME="132"></A> * @param value String
150<FONT CLASS="LN">33</FONT><A NAME="133"></A> * @return boolean
151<FONT CLASS="LN">34</FONT><A NAME="134"></A> */</FONT>
152<FONT CLASS="LN">35</FONT><A NAME="135"></A> <FONT CLASS="Public">public</FONT> <FONT CLASS="Static">static</FONT> <FONT CLASS="Boolean">boolean</FONT> requiredBoolean(String value){
153<FONT CLASS="LN">36</FONT><A NAME="136"></A> <FONT CLASS="Return">return</FONT> isTrue(value) || isFalse(value);
154<FONT CLASS="LN">37</FONT><A NAME="137"></A> }
155<FONT CLASS="LN">38</FONT><A NAME="138"></A> <FONT CLASS="FormalComment">/**
156<FONT CLASS="LN">39</FONT><A NAME="139"></A> * Return true if the value is set to true or false, returns false if the value is null
157<FONT CLASS="LN">40</FONT><A NAME="140"></A> * @param value String
158<FONT CLASS="LN">41</FONT><A NAME="141"></A> * @return boolean
159<FONT CLASS="LN">42</FONT><A NAME="142"></A> */</FONT>
160<FONT CLASS="LN">43</FONT><A NAME="143"></A> <FONT CLASS="Public">public</FONT> <FONT CLASS="Static">static</FONT> <FONT CLASS="Boolean">boolean</FONT> optionalBoolean(String value){
161<FONT CLASS="LN">44</FONT><A NAME="144"></A> <FONT CLASS="Return">return</FONT> value == <FONT CLASS="Null">null</FONT> || isTrue(value) || isFalse(value);
162<FONT CLASS="LN">45</FONT><A NAME="145"></A> }
163<FONT CLASS="LN">46</FONT><A NAME="146"></A>}
164<FONT CLASS="LN">47</FONT><A NAME="147"></A></pre>
165</BODY>
166</HTML>
Note: See TracBrowser for help on using the repository browser.