source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/taskdefs/StreamPumper.html@ 14627

Last change on this file since 14627 was 14627, checked in by oranfry, 17 years ago

initial import of the gs3-release-maker
File size: 12.8 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:22 NZST 2007 -->
6<TITLE>
7StreamPumper (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.StreamPumper 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="StreamPumper (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/taskdefs/SQLExec.Transaction.html" title="class in org.apache.tools.ant.taskdefs"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../org/apache/tools/ant/taskdefs/SubAnt.html" title="class in org.apache.tools.ant.taskdefs"><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="StreamPumper.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.taskdefs</FONT>
85<BR>
86Class StreamPumper</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.taskdefs.StreamPumper</B>
90</PRE>
91<DL>
92<DT><B>All Implemented Interfaces:</B> <DD>java.lang.Runnable</DD>
93</DL>
94<HR>
95<DL>
96<DT>public class <B>StreamPumper</B><DT>extends java.lang.Object<DT>implements java.lang.Runnable</DL>
97
98<P>
99Copies all data from an input stream to an output stream.
100<P>
101
102<P>
103<DL>
104<DT><B>Since:</B></DT>
105 <DD>Ant 1.2</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/taskdefs/StreamPumper.html#StreamPumper(java.io.InputStream, java.io.OutputStream)">StreamPumper</A></B>(java.io.InputStream&nbsp;is,
126 java.io.OutputStream&nbsp;os)</CODE>
127
128<BR>
129&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create a new stream pumper.</TD>
130</TR>
131<TR BGCOLOR="white" CLASS="TableRowColor">
132<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/StreamPumper.html#StreamPumper(java.io.InputStream, java.io.OutputStream, boolean)">StreamPumper</A></B>(java.io.InputStream&nbsp;is,
133 java.io.OutputStream&nbsp;os,
134 boolean&nbsp;closeWhenExhausted)</CODE>
135
136<BR>
137&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create a new stream pumper.</TD>
138</TR>
139</TABLE>
140&nbsp;
141<!-- ========== METHOD SUMMARY =========== -->
142
143<A NAME="method_summary"><!-- --></A>
144<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
145<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
146<TD COLSPAN=2><FONT SIZE="+2">
147<B>Method Summary</B></FONT></TD>
148</TR>
149<TR BGCOLOR="white" CLASS="TableRowColor">
150<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
151<CODE>&nbsp;boolean</CODE></FONT></TD>
152<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/StreamPumper.html#isFinished()">isFinished</A></B>()</CODE>
153
154<BR>
155&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tells whether the end of the stream has been reached.</TD>
156</TR>
157<TR BGCOLOR="white" CLASS="TableRowColor">
158<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
159<CODE>&nbsp;void</CODE></FONT></TD>
160<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/StreamPumper.html#run()">run</A></B>()</CODE>
161
162<BR>
163&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Copies data from the input stream to the output stream.</TD>
164</TR>
165<TR BGCOLOR="white" CLASS="TableRowColor">
166<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
167<CODE>&nbsp;void</CODE></FONT></TD>
168<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/StreamPumper.html#waitFor()">waitFor</A></B>()</CODE>
169
170<BR>
171&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method blocks until the stream pumper finishes.</TD>
172</TR>
173</TABLE>
174&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
175<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
176<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
177<TD><B>Methods inherited from class java.lang.Object</B></TD>
178</TR>
179<TR BGCOLOR="white" CLASS="TableRowColor">
180<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
181</TR>
182</TABLE>
183&nbsp;
184<P>
185
186<!-- ============ FIELD DETAIL =========== -->
187
188
189<!-- ========= CONSTRUCTOR DETAIL ======== -->
190
191<A NAME="constructor_detail"><!-- --></A>
192<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
193<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
194<TD COLSPAN=1><FONT SIZE="+2">
195<B>Constructor Detail</B></FONT></TD>
196</TR>
197</TABLE>
198
199<A NAME="StreamPumper(java.io.InputStream, java.io.OutputStream, boolean)"><!-- --></A><H3>
200StreamPumper</H3>
201<PRE>
202public <B>StreamPumper</B>(java.io.InputStream&nbsp;is,
203 java.io.OutputStream&nbsp;os,
204 boolean&nbsp;closeWhenExhausted)</PRE>
205<DL>
206<DD>Create a new stream pumper.
207<P>
208<DT><B>Parameters:</B><DD><CODE>is</CODE> - input stream to read data from<DD><CODE>os</CODE> - output stream to write data to.<DD><CODE>closeWhenExhausted</CODE> - if true, the output stream will be closed when
209 the input is exhausted.</DL>
210<HR>
211
212<A NAME="StreamPumper(java.io.InputStream, java.io.OutputStream)"><!-- --></A><H3>
213StreamPumper</H3>
214<PRE>
215public <B>StreamPumper</B>(java.io.InputStream&nbsp;is,
216 java.io.OutputStream&nbsp;os)</PRE>
217<DL>
218<DD>Create a new stream pumper.
219<P>
220<DT><B>Parameters:</B><DD><CODE>is</CODE> - input stream to read data from<DD><CODE>os</CODE> - output stream to write data to.</DL>
221
222<!-- ============ METHOD DETAIL ========== -->
223
224<A NAME="method_detail"><!-- --></A>
225<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
226<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
227<TD COLSPAN=1><FONT SIZE="+2">
228<B>Method Detail</B></FONT></TD>
229</TR>
230</TABLE>
231
232<A NAME="run()"><!-- --></A><H3>
233run</H3>
234<PRE>
235public void <B>run</B>()</PRE>
236<DL>
237<DD>Copies data from the input stream to the output stream.
238
239 Terminates as soon as the input stream is closed or an error occurs.
240<P>
241<DD><DL>
242<DT><B>Specified by:</B><DD><CODE>run</CODE> in interface <CODE>java.lang.Runnable</CODE></DL>
243</DD>
244<DD><DL>
245</DL>
246</DD>
247</DL>
248<HR>
249
250<A NAME="isFinished()"><!-- --></A><H3>
251isFinished</H3>
252<PRE>
253public boolean <B>isFinished</B>()</PRE>
254<DL>
255<DD>Tells whether the end of the stream has been reached.
256<P>
257<DD><DL>
258</DL>
259</DD>
260<DD><DL>
261
262<DT><B>Returns:</B><DD>true is the stream has been exhausted.</DL>
263</DD>
264</DL>
265<HR>
266
267<A NAME="waitFor()"><!-- --></A><H3>
268waitFor</H3>
269<PRE>
270public void <B>waitFor</B>()
271 throws java.lang.InterruptedException</PRE>
272<DL>
273<DD>This method blocks until the stream pumper finishes.
274<P>
275<DD><DL>
276</DL>
277</DD>
278<DD><DL>
279
280<DT><B>Throws:</B>
281<DD><CODE>java.lang.InterruptedException</CODE><DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/tools/ant/taskdefs/StreamPumper.html#isFinished()"><CODE>isFinished()</CODE></A></DL>
282</DD>
283</DL>
284<!-- ========= END OF CLASS DATA ========= -->
285<HR>
286
287
288<!-- ======= START OF BOTTOM NAVBAR ====== -->
289<A NAME="navbar_bottom"><!-- --></A>
290<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
291<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
292<TR>
293<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
294<A NAME="navbar_bottom_firstrow"><!-- --></A>
295<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
296 <TR ALIGN="center" VALIGN="top">
297 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
298 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
299 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
300 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
301 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
302 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
303 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
304 </TR>
305</TABLE>
306</TD>
307<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
308</EM>
309</TD>
310</TR>
311
312<TR>
313<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
314&nbsp;<A HREF="../../../../../org/apache/tools/ant/taskdefs/SQLExec.Transaction.html" title="class in org.apache.tools.ant.taskdefs"><B>PREV CLASS</B></A>&nbsp;
315&nbsp;<A HREF="../../../../../org/apache/tools/ant/taskdefs/SubAnt.html" title="class in org.apache.tools.ant.taskdefs"><B>NEXT CLASS</B></A></FONT></TD>
316<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
317 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
318&nbsp;<A HREF="StreamPumper.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
319&nbsp;<SCRIPT type="text/javascript">
320 <!--
321 if(window==top) {
322 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
323 }
324 //-->
325</SCRIPT>
326<NOSCRIPT>
327 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
328</NOSCRIPT>
329
330</FONT></TD>
331</TR>
332<TR>
333<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
334 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
335<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
336DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
337</TR>
338</TABLE>
339<A NAME="skip-navbar_bottom"></A>
340<!-- ======== END OF BOTTOM NAVBAR ======= -->
341
342<HR>
343Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
344</BODY>
345</HTML>
Note: See TracBrowser for help on using the repository browser.