source: release-kits/lirk3/resources/gs3-release-maker/ant/docs/manual/api/org/apache/tools/ant/input/MultipleChoiceInputRequest.html@ 14982

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

initial import of LiRK3
File size: 12.4 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.4.2_13) on Mon Oct 01 14:33:17 NZST 2007 -->
6<TITLE>
7MultipleChoiceInputRequest (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.input.MultipleChoiceInputRequest class">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17 parent.document.title="MultipleChoiceInputRequest (Apache Ant API)";
18}
19</SCRIPT>
20
21</HEAD>
22
23<BODY BGCOLOR="white" onload="windowTitle();">
24
25
26<!-- ========= START OF TOP NAVBAR ======= -->
27<A NAME="navbar_top"><!-- --></A>
28<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
29<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
30<TR>
31<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
32<A NAME="navbar_top_firstrow"><!-- --></A>
33<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
34 <TR ALIGN="center" VALIGN="top">
35 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
37 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
42 </TR>
43</TABLE>
44</TD>
45<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
46</EM>
47</TD>
48</TR>
49
50<TR>
51<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
52&nbsp;<A HREF="../../../../../org/apache/tools/ant/input/InputRequest.html" title="class in org.apache.tools.ant.input"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../org/apache/tools/ant/input/PropertyFileInputHandler.html" title="class in org.apache.tools.ant.input"><B>NEXT CLASS</B></A></FONT></TD>
54<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
55 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
56&nbsp;<A HREF="MultipleChoiceInputRequest.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
57&nbsp;<SCRIPT type="text/javascript">
58 <!--
59 if(window==top) {
60 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
61 }
62 //-->
63</SCRIPT>
64<NOSCRIPT>
65 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
66</NOSCRIPT>
67
68</FONT></TD>
69</TR>
70<TR>
71<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
72 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
73<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
75</TR>
76</TABLE>
77<A NAME="skip-navbar_top"></A>
78<!-- ========= END OF TOP NAVBAR ========= -->
79
80<HR>
81<!-- ======== START OF CLASS DATA ======== -->
82<H2>
83<FONT SIZE="-1">
84org.apache.tools.ant.input</FONT>
85<BR>
86Class MultipleChoiceInputRequest</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../org/apache/tools/ant/input/InputRequest.html" title="class in org.apache.tools.ant.input">org.apache.tools.ant.input.InputRequest</A>
90 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.input.MultipleChoiceInputRequest</B>
91</PRE>
92<HR>
93<DL>
94<DT>public class <B>MultipleChoiceInputRequest</B><DT>extends <A HREF="../../../../../org/apache/tools/ant/input/InputRequest.html" title="class in org.apache.tools.ant.input">InputRequest</A></DL>
95
96<P>
97Encapsulates an input request.
98<P>
99
100<P>
101<DL>
102<DT><B>Since:</B></DT>
103 <DD>Ant 1.5</DD>
104</DL>
105<HR>
106
107<P>
108<!-- ======== NESTED CLASS SUMMARY ======== -->
109
110
111<!-- =========== FIELD SUMMARY =========== -->
112
113
114<!-- ======== CONSTRUCTOR SUMMARY ======== -->
115
116<A NAME="constructor_summary"><!-- --></A>
117<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
118<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
119<TD COLSPAN=2><FONT SIZE="+2">
120<B>Constructor Summary</B></FONT></TD>
121</TR>
122<TR BGCOLOR="white" CLASS="TableRowColor">
123<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/input/MultipleChoiceInputRequest.html#MultipleChoiceInputRequest(java.lang.String, java.util.Vector)">MultipleChoiceInputRequest</A></B>(java.lang.String&nbsp;prompt,
124 java.util.Vector&nbsp;choices)</CODE>
125
126<BR>
127&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
128</TR>
129</TABLE>
130&nbsp;
131<!-- ========== METHOD SUMMARY =========== -->
132
133<A NAME="method_summary"><!-- --></A>
134<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
135<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
136<TD COLSPAN=2><FONT SIZE="+2">
137<B>Method Summary</B></FONT></TD>
138</TR>
139<TR BGCOLOR="white" CLASS="TableRowColor">
140<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
141<CODE>&nbsp;java.util.Vector</CODE></FONT></TD>
142<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/input/MultipleChoiceInputRequest.html#getChoices()">getChoices</A></B>()</CODE>
143
144<BR>
145&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
146</TR>
147<TR BGCOLOR="white" CLASS="TableRowColor">
148<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
149<CODE>&nbsp;boolean</CODE></FONT></TD>
150<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/input/MultipleChoiceInputRequest.html#isInputValid()">isInputValid</A></B>()</CODE>
151
152<BR>
153&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Is the user input valid?</TD>
154</TR>
155</TABLE>
156&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.input.InputRequest"><!-- --></A>
157<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
158<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
159<TD><B>Methods inherited from class org.apache.tools.ant.input.<A HREF="../../../../../org/apache/tools/ant/input/InputRequest.html" title="class in org.apache.tools.ant.input">InputRequest</A></B></TD>
160</TR>
161<TR BGCOLOR="white" CLASS="TableRowColor">
162<TD><CODE><A HREF="../../../../../org/apache/tools/ant/input/InputRequest.html#getInput()">getInput</A>, <A HREF="../../../../../org/apache/tools/ant/input/InputRequest.html#getPrompt()">getPrompt</A>, <A HREF="../../../../../org/apache/tools/ant/input/InputRequest.html#setInput(java.lang.String)">setInput</A></CODE></TD>
163</TR>
164</TABLE>
165&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
166<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
167<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
168<TD><B>Methods inherited from class java.lang.Object</B></TD>
169</TR>
170<TR BGCOLOR="white" CLASS="TableRowColor">
171<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
172</TR>
173</TABLE>
174&nbsp;
175<P>
176
177<!-- ============ FIELD DETAIL =========== -->
178
179
180<!-- ========= CONSTRUCTOR DETAIL ======== -->
181
182<A NAME="constructor_detail"><!-- --></A>
183<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
184<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
185<TD COLSPAN=1><FONT SIZE="+2">
186<B>Constructor Detail</B></FONT></TD>
187</TR>
188</TABLE>
189
190<A NAME="MultipleChoiceInputRequest(java.lang.String, java.util.Vector)"><!-- --></A><H3>
191MultipleChoiceInputRequest</H3>
192<PRE>
193public <B>MultipleChoiceInputRequest</B>(java.lang.String&nbsp;prompt,
194 java.util.Vector&nbsp;choices)</PRE>
195<DL>
196<DT><B>Parameters:</B><DD><CODE>prompt</CODE> - The prompt to show to the user. Must not be null.<DD><CODE>choices</CODE> - holds all input values that are allowed.
197 Must not be null.</DL>
198
199<!-- ============ METHOD DETAIL ========== -->
200
201<A NAME="method_detail"><!-- --></A>
202<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
203<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
204<TD COLSPAN=1><FONT SIZE="+2">
205<B>Method Detail</B></FONT></TD>
206</TR>
207</TABLE>
208
209<A NAME="getChoices()"><!-- --></A><H3>
210getChoices</H3>
211<PRE>
212public java.util.Vector <B>getChoices</B>()</PRE>
213<DL>
214<DD><DL>
215
216<DT><B>Returns:</B><DD>The possible values.</DL>
217</DD>
218</DL>
219<HR>
220
221<A NAME="isInputValid()"><!-- --></A><H3>
222isInputValid</H3>
223<PRE>
224public boolean <B>isInputValid</B>()</PRE>
225<DL>
226<DD><B>Description copied from class: <CODE><A HREF="../../../../../org/apache/tools/ant/input/InputRequest.html" title="class in org.apache.tools.ant.input">InputRequest</A></CODE></B></DD>
227<DD>Is the user input valid?
228<P>
229<DD><DL>
230<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/tools/ant/input/InputRequest.html#isInputValid()">isInputValid</A></CODE> in class <CODE><A HREF="../../../../../org/apache/tools/ant/input/InputRequest.html" title="class in org.apache.tools.ant.input">InputRequest</A></CODE></DL>
231</DD>
232<DD><DL>
233
234<DT><B>Returns:</B><DD>true if the input is one of the allowed values.</DL>
235</DD>
236</DL>
237<!-- ========= END OF CLASS DATA ========= -->
238<HR>
239
240
241<!-- ======= START OF BOTTOM NAVBAR ====== -->
242<A NAME="navbar_bottom"><!-- --></A>
243<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
244<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
245<TR>
246<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
247<A NAME="navbar_bottom_firstrow"><!-- --></A>
248<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
249 <TR ALIGN="center" VALIGN="top">
250 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
251 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
252 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
253 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
254 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
255 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
256 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
257 </TR>
258</TABLE>
259</TD>
260<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
261</EM>
262</TD>
263</TR>
264
265<TR>
266<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
267&nbsp;<A HREF="../../../../../org/apache/tools/ant/input/InputRequest.html" title="class in org.apache.tools.ant.input"><B>PREV CLASS</B></A>&nbsp;
268&nbsp;<A HREF="../../../../../org/apache/tools/ant/input/PropertyFileInputHandler.html" title="class in org.apache.tools.ant.input"><B>NEXT CLASS</B></A></FONT></TD>
269<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
270 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
271&nbsp;<A HREF="MultipleChoiceInputRequest.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
272&nbsp;<SCRIPT type="text/javascript">
273 <!--
274 if(window==top) {
275 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
276 }
277 //-->
278</SCRIPT>
279<NOSCRIPT>
280 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
281</NOSCRIPT>
282
283</FONT></TD>
284</TR>
285<TR>
286<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
287 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
288<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
289DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
290</TR>
291</TABLE>
292<A NAME="skip-navbar_bottom"></A>
293<!-- ======== END OF BOTTOM NAVBAR ======= -->
294
295<HR>
296Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
297</BODY>
298</HTML>
Note: See TracBrowser for help on using the repository browser.