source: release-kits/lirk3/resources/gs3-release-maker/ant/docs/manual/api/org/apache/tools/ant/input/DefaultInputHandler.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.9 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>
7DefaultInputHandler (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.input.DefaultInputHandler 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="DefaultInputHandler (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;PREV CLASS&nbsp;
53&nbsp;<A HREF="../../../../../org/apache/tools/ant/input/InputRequest.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="DefaultInputHandler.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 DefaultInputHandler</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.input.DefaultInputHandler</B>
90</PRE>
91<DL>
92<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../org/apache/tools/ant/input/InputHandler.html" title="interface in org.apache.tools.ant.input">InputHandler</A></DD>
93</DL>
94<HR>
95<DL>
96<DT>public class <B>DefaultInputHandler</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../../org/apache/tools/ant/input/InputHandler.html" title="interface in org.apache.tools.ant.input">InputHandler</A></DL>
97
98<P>
99Prompts on System.err, reads input from System.in
100<P>
101
102<P>
103<DL>
104<DT><B>Since:</B></DT>
105 <DD>Ant 1.5</DD>
106</DL>
107<HR>
108
109<P>
110<!-- ======== NESTED CLASS SUMMARY ======== -->
111
112
113<!-- =========== FIELD SUMMARY =========== -->
114
115
116<!-- ======== CONSTRUCTOR SUMMARY ======== -->
117
118<A NAME="constructor_summary"><!-- --></A>
119<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
120<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
121<TD COLSPAN=2><FONT SIZE="+2">
122<B>Constructor Summary</B></FONT></TD>
123</TR>
124<TR BGCOLOR="white" CLASS="TableRowColor">
125<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/input/DefaultInputHandler.html#DefaultInputHandler()">DefaultInputHandler</A></B>()</CODE>
126
127<BR>
128&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Empty no-arg constructor</TD>
129</TR>
130</TABLE>
131&nbsp;
132<!-- ========== METHOD SUMMARY =========== -->
133
134<A NAME="method_summary"><!-- --></A>
135<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
136<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
137<TD COLSPAN=2><FONT SIZE="+2">
138<B>Method Summary</B></FONT></TD>
139</TR>
140<TR BGCOLOR="white" CLASS="TableRowColor">
141<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
142<CODE>protected &nbsp;java.io.InputStream</CODE></FONT></TD>
143<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/input/DefaultInputHandler.html#getInputStream()">getInputStream</A></B>()</CODE>
144
145<BR>
146&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the input stream from which the user input should be read.</TD>
147</TR>
148<TR BGCOLOR="white" CLASS="TableRowColor">
149<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
150<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
151<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/input/DefaultInputHandler.html#getPrompt(org.apache.tools.ant.input.InputRequest)">getPrompt</A></B>(<A HREF="../../../../../org/apache/tools/ant/input/InputRequest.html" title="class in org.apache.tools.ant.input">InputRequest</A>&nbsp;request)</CODE>
152
153<BR>
154&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs user prompt from a request.</TD>
155</TR>
156<TR BGCOLOR="white" CLASS="TableRowColor">
157<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
158<CODE>&nbsp;void</CODE></FONT></TD>
159<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/input/DefaultInputHandler.html#handleInput(org.apache.tools.ant.input.InputRequest)">handleInput</A></B>(<A HREF="../../../../../org/apache/tools/ant/input/InputRequest.html" title="class in org.apache.tools.ant.input">InputRequest</A>&nbsp;request)</CODE>
160
161<BR>
162&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Prompts and requests input.</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="DefaultInputHandler()"><!-- --></A><H3>
191DefaultInputHandler</H3>
192<PRE>
193public <B>DefaultInputHandler</B>()</PRE>
194<DL>
195<DD>Empty no-arg constructor
196<P>
197</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="handleInput(org.apache.tools.ant.input.InputRequest)"><!-- --></A><H3>
210handleInput</H3>
211<PRE>
212public void <B>handleInput</B>(<A HREF="../../../../../org/apache/tools/ant/input/InputRequest.html" title="class in org.apache.tools.ant.input">InputRequest</A>&nbsp;request)
213 throws <A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
214<DL>
215<DD>Prompts and requests input. May loop until a valid input has
216 been entered.
217<P>
218<DD><DL>
219<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/tools/ant/input/InputHandler.html#handleInput(org.apache.tools.ant.input.InputRequest)">handleInput</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/tools/ant/input/InputHandler.html" title="interface in org.apache.tools.ant.input">InputHandler</A></CODE></DL>
220</DD>
221<DD><DL>
222<DT><B>Parameters:</B><DD><CODE>request</CODE> - the request to handle
223<DT><B>Throws:</B>
224<DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if not possible to read from console</DL>
225</DD>
226</DL>
227<HR>
228
229<A NAME="getPrompt(org.apache.tools.ant.input.InputRequest)"><!-- --></A><H3>
230getPrompt</H3>
231<PRE>
232protected java.lang.String <B>getPrompt</B>(<A HREF="../../../../../org/apache/tools/ant/input/InputRequest.html" title="class in org.apache.tools.ant.input">InputRequest</A>&nbsp;request)</PRE>
233<DL>
234<DD>Constructs user prompt from a request.
235
236 <p>This implementation adds (choice1,choice2,choice3,...) to the
237 prompt for <code>MultipleChoiceInputRequest</code>s.</p>
238<P>
239<DD><DL>
240</DL>
241</DD>
242<DD><DL>
243<DT><B>Parameters:</B><DD><CODE>request</CODE> - the request to construct the prompt for.
244 Must not be <code>null</code>.
245<DT><B>Returns:</B><DD>the prompt to ask the user</DL>
246</DD>
247</DL>
248<HR>
249
250<A NAME="getInputStream()"><!-- --></A><H3>
251getInputStream</H3>
252<PRE>
253protected java.io.InputStream <B>getInputStream</B>()</PRE>
254<DL>
255<DD>Returns the input stream from which the user input should be read.
256<P>
257<DD><DL>
258</DL>
259</DD>
260<DD><DL>
261
262<DT><B>Returns:</B><DD>the input stream from which the user input should be read.</DL>
263</DD>
264</DL>
265<!-- ========= END OF CLASS DATA ========= -->
266<HR>
267
268
269<!-- ======= START OF BOTTOM NAVBAR ====== -->
270<A NAME="navbar_bottom"><!-- --></A>
271<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
272<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
273<TR>
274<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
275<A NAME="navbar_bottom_firstrow"><!-- --></A>
276<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
277 <TR ALIGN="center" VALIGN="top">
278 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
279 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
280 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
281 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
282 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
283 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
284 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
285 </TR>
286</TABLE>
287</TD>
288<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
289</EM>
290</TD>
291</TR>
292
293<TR>
294<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
295&nbsp;PREV CLASS&nbsp;
296&nbsp;<A HREF="../../../../../org/apache/tools/ant/input/InputRequest.html" title="class in org.apache.tools.ant.input"><B>NEXT CLASS</B></A></FONT></TD>
297<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
298 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
299&nbsp;<A HREF="DefaultInputHandler.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
300&nbsp;<SCRIPT type="text/javascript">
301 <!--
302 if(window==top) {
303 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
304 }
305 //-->
306</SCRIPT>
307<NOSCRIPT>
308 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
309</NOSCRIPT>
310
311</FONT></TD>
312</TR>
313<TR>
314<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
315 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
316<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
317DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
318</TR>
319</TABLE>
320<A NAME="skip-navbar_bottom"></A>
321<!-- ======== END OF BOTTOM NAVBAR ======= -->
322
323<HR>
324Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
325</BODY>
326</HTML>
Note: See TracBrowser for help on using the repository browser.