source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/util/OutputStreamFunneler.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: 14.0 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:35 NZST 2007 -->
6<TITLE>
7OutputStreamFunneler (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.util.OutputStreamFunneler 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="OutputStreamFunneler (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/util/MergingMapper.html" title="class in org.apache.tools.ant.util"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../org/apache/tools/ant/util/PackageNameMapper.html" title="class in org.apache.tools.ant.util"><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="OutputStreamFunneler.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;<A HREF="#field_summary">FIELD</A>&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;<A HREF="#field_detail">FIELD</A>&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.util</FONT>
85<BR>
86Class OutputStreamFunneler</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.util.OutputStreamFunneler</B>
90</PRE>
91<HR>
92<DL>
93<DT>public class <B>OutputStreamFunneler</B><DT>extends java.lang.Object</DL>
94
95<P>
96Manages a set of <CODE>OutputStream</CODE>s to
97 write to a single underlying stream, which is
98 closed only when the last &quot;funnel&quot;
99 has been closed.
100<P>
101
102<P>
103<HR>
104
105<P>
106<!-- ======== NESTED CLASS SUMMARY ======== -->
107
108
109<!-- =========== FIELD SUMMARY =========== -->
110
111<A NAME="field_summary"><!-- --></A>
112<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
113<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
114<TD COLSPAN=2><FONT SIZE="+2">
115<B>Field Summary</B></FONT></TD>
116</TR>
117<TR BGCOLOR="white" CLASS="TableRowColor">
118<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
119<CODE>static&nbsp;long</CODE></FONT></TD>
120<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/util/OutputStreamFunneler.html#DEFAULT_TIMEOUT_MILLIS">DEFAULT_TIMEOUT_MILLIS</A></B></CODE>
121
122<BR>
123&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default timeout.</TD>
124</TR>
125</TABLE>
126&nbsp;
127<!-- ======== CONSTRUCTOR SUMMARY ======== -->
128
129<A NAME="constructor_summary"><!-- --></A>
130<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
131<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
132<TD COLSPAN=2><FONT SIZE="+2">
133<B>Constructor Summary</B></FONT></TD>
134</TR>
135<TR BGCOLOR="white" CLASS="TableRowColor">
136<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/util/OutputStreamFunneler.html#OutputStreamFunneler(java.io.OutputStream)">OutputStreamFunneler</A></B>(java.io.OutputStream&nbsp;out)</CODE>
137
138<BR>
139&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create a new <CODE>OutputStreamFunneler</CODE> for
140 the specified <CODE>OutputStream</CODE>.</TD>
141</TR>
142<TR BGCOLOR="white" CLASS="TableRowColor">
143<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/util/OutputStreamFunneler.html#OutputStreamFunneler(java.io.OutputStream, long)">OutputStreamFunneler</A></B>(java.io.OutputStream&nbsp;out,
144 long&nbsp;timeoutMillis)</CODE>
145
146<BR>
147&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create a new <CODE>OutputStreamFunneler</CODE> for
148 the specified <CODE>OutputStream</CODE>, with the
149 specified timeout value.</TD>
150</TR>
151</TABLE>
152&nbsp;
153<!-- ========== METHOD SUMMARY =========== -->
154
155<A NAME="method_summary"><!-- --></A>
156<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
157<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
158<TD COLSPAN=2><FONT SIZE="+2">
159<B>Method Summary</B></FONT></TD>
160</TR>
161<TR BGCOLOR="white" CLASS="TableRowColor">
162<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
163<CODE>&nbsp;java.io.OutputStream</CODE></FONT></TD>
164<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/util/OutputStreamFunneler.html#getFunnelInstance()">getFunnelInstance</A></B>()</CODE>
165
166<BR>
167&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get a &quot;funnel&quot; <CODE>OutputStream</CODE> instance to
168 write to this <CODE>OutputStreamFunneler</CODE>'s underlying
169 <CODE>OutputStream</CODE>.</TD>
170</TR>
171<TR BGCOLOR="white" CLASS="TableRowColor">
172<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
173<CODE>&nbsp;void</CODE></FONT></TD>
174<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/util/OutputStreamFunneler.html#setTimeout(long)">setTimeout</A></B>(long&nbsp;timeoutMillis)</CODE>
175
176<BR>
177&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the timeout for this <CODE>OutputStreamFunneler</CODE>.</TD>
178</TR>
179</TABLE>
180&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
181<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
182<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
183<TD><B>Methods inherited from class java.lang.Object</B></TD>
184</TR>
185<TR BGCOLOR="white" CLASS="TableRowColor">
186<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
187</TR>
188</TABLE>
189&nbsp;
190<P>
191
192<!-- ============ FIELD DETAIL =========== -->
193
194<A NAME="field_detail"><!-- --></A>
195<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
196<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
197<TD COLSPAN=1><FONT SIZE="+2">
198<B>Field Detail</B></FONT></TD>
199</TR>
200</TABLE>
201
202<A NAME="DEFAULT_TIMEOUT_MILLIS"><!-- --></A><H3>
203DEFAULT_TIMEOUT_MILLIS</H3>
204<PRE>
205public static final long <B>DEFAULT_TIMEOUT_MILLIS</B></PRE>
206<DL>
207<DD>Default timeout.
208<P>
209<DL>
210<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/tools/ant/util/OutputStreamFunneler.html#setTimeout(long)"><CODE>setTimeout(long)</CODE></A>,
211<A HREF="../../../../../constant-values.html#org.apache.tools.ant.util.OutputStreamFunneler.DEFAULT_TIMEOUT_MILLIS">Constant Field Values</A></DL>
212</DL>
213
214<!-- ========= CONSTRUCTOR DETAIL ======== -->
215
216<A NAME="constructor_detail"><!-- --></A>
217<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
218<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
219<TD COLSPAN=1><FONT SIZE="+2">
220<B>Constructor Detail</B></FONT></TD>
221</TR>
222</TABLE>
223
224<A NAME="OutputStreamFunneler(java.io.OutputStream)"><!-- --></A><H3>
225OutputStreamFunneler</H3>
226<PRE>
227public <B>OutputStreamFunneler</B>(java.io.OutputStream&nbsp;out)</PRE>
228<DL>
229<DD>Create a new <CODE>OutputStreamFunneler</CODE> for
230 the specified <CODE>OutputStream</CODE>.
231<P>
232<DT><B>Parameters:</B><DD><CODE>out</CODE> - <CODE>OutputStream</CODE>.</DL>
233<HR>
234
235<A NAME="OutputStreamFunneler(java.io.OutputStream, long)"><!-- --></A><H3>
236OutputStreamFunneler</H3>
237<PRE>
238public <B>OutputStreamFunneler</B>(java.io.OutputStream&nbsp;out,
239 long&nbsp;timeoutMillis)</PRE>
240<DL>
241<DD>Create a new <CODE>OutputStreamFunneler</CODE> for
242 the specified <CODE>OutputStream</CODE>, with the
243 specified timeout value.
244<P>
245<DT><B>Parameters:</B><DD><CODE>out</CODE> - <CODE>OutputStream</CODE>.<DD><CODE>timeoutMillis</CODE> - <CODE>long</CODE>.<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/tools/ant/util/OutputStreamFunneler.html#setTimeout(long)"><CODE>setTimeout(long)</CODE></A></DL>
246
247<!-- ============ METHOD DETAIL ========== -->
248
249<A NAME="method_detail"><!-- --></A>
250<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
251<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
252<TD COLSPAN=1><FONT SIZE="+2">
253<B>Method Detail</B></FONT></TD>
254</TR>
255</TABLE>
256
257<A NAME="setTimeout(long)"><!-- --></A><H3>
258setTimeout</H3>
259<PRE>
260public void <B>setTimeout</B>(long&nbsp;timeoutMillis)</PRE>
261<DL>
262<DD>Set the timeout for this <CODE>OutputStreamFunneler</CODE>.
263 This is the maximum time that may elapse between the closure
264 of the last &quot;funnel&quot; and the next call to
265 <CODE>getOutputStream()</CODE> without closing the
266 underlying stream.
267<P>
268<DD><DL>
269<DT><B>Parameters:</B><DD><CODE>timeoutMillis</CODE> - <CODE>long</CODE> timeout value.</DL>
270</DD>
271</DL>
272<HR>
273
274<A NAME="getFunnelInstance()"><!-- --></A><H3>
275getFunnelInstance</H3>
276<PRE>
277public java.io.OutputStream <B>getFunnelInstance</B>()
278 throws java.io.IOException</PRE>
279<DL>
280<DD>Get a &quot;funnel&quot; <CODE>OutputStream</CODE> instance to
281 write to this <CODE>OutputStreamFunneler</CODE>'s underlying
282 <CODE>OutputStream</CODE>.
283<P>
284<DD><DL>
285
286<DT><B>Returns:</B><DD><code>OutputStream</code>.
287<DT><B>Throws:</B>
288<DD><CODE>java.io.IOException</CODE> - if unable to create the funnel.</DL>
289</DD>
290</DL>
291<!-- ========= END OF CLASS DATA ========= -->
292<HR>
293
294
295<!-- ======= START OF BOTTOM NAVBAR ====== -->
296<A NAME="navbar_bottom"><!-- --></A>
297<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
298<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
299<TR>
300<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
301<A NAME="navbar_bottom_firstrow"><!-- --></A>
302<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
303 <TR ALIGN="center" VALIGN="top">
304 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
305 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
306 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
307 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
308 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
309 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
310 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
311 </TR>
312</TABLE>
313</TD>
314<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
315</EM>
316</TD>
317</TR>
318
319<TR>
320<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
321&nbsp;<A HREF="../../../../../org/apache/tools/ant/util/MergingMapper.html" title="class in org.apache.tools.ant.util"><B>PREV CLASS</B></A>&nbsp;
322&nbsp;<A HREF="../../../../../org/apache/tools/ant/util/PackageNameMapper.html" title="class in org.apache.tools.ant.util"><B>NEXT CLASS</B></A></FONT></TD>
323<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
324 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
325&nbsp;<A HREF="OutputStreamFunneler.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
326&nbsp;<SCRIPT type="text/javascript">
327 <!--
328 if(window==top) {
329 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
330 }
331 //-->
332</SCRIPT>
333<NOSCRIPT>
334 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
335</NOSCRIPT>
336
337</FONT></TD>
338</TR>
339<TR>
340<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
341 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
342<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
343DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
344</TR>
345</TABLE>
346<A NAME="skip-navbar_bottom"></A>
347<!-- ======== END OF BOTTOM NAVBAR ======= -->
348
349<HR>
350Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
351</BODY>
352</HTML>
Note: See TracBrowser for help on using the repository browser.