Edit C:\apache-ant-1.8.0\docs\manual\api\org\apache\tools\ant\taskdefs\StreamPumper.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">

<HTML>
<HEAD>

<TITLE>
StreamPumper (Apache Ant API)
</TITLE>

<SCRIPT type="text/javascript">
function windowTitle()
{
 parent.document.title="StreamPumper (Apache Ant API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>

</HEAD>

<A NAME="navbar_top"></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 <TR ALIGN="center" VALIGN="top">
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html">Overview</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html">Package</A>&nbsp;</TD>
 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;Class&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html">Tree</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html">Deprecated</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html">Index</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html">Help</A>&nbsp;</TD>
 </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3>

</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2">
&nbsp;<A HREF="../../../../../org/apache/tools/ant/taskdefs/SQLExec.Transaction.html" title="class in org.apache.tools.ant.taskdefs">PREV CLASS</A>&nbsp;
&nbsp;<A HREF="../../../../../org/apache/tools/ant/taskdefs/SubAnt.html" title="class in org.apache.tools.ant.taskdefs">NEXT CLASS</A></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2">
 <A HREF="../../../../../index.html?org/apache/tools/ant/taskdefs/StreamPumper.html" target="_top">FRAMES</A> &nbsp;
&nbsp;<A HREF="StreamPumper.html" target="_top">NO FRAMES</A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
 
</SCRIPT>
<NOSCRIPT>
 <A HREF="../../../../../allclasses-noframe.html">All Classes</A>
</NOSCRIPT>

</TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3">
 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></TD>
<TD VALIGN="top" CLASS="NavBarCell3">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>

<HR>

<H2>

org.apache.tools.ant.taskdefs
 
Class StreamPumper</H2>
<PRE>
java.lang.Object
 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">org.apache.tools.ant.taskdefs.StreamPumper
</PRE>
<DL>
<DT>All Implemented Interfaces: <DD>java.lang.Runnable</DD>
</DL>
<HR>
<DL>
<DT><PRE>public class StreamPumper<DT>extends java.lang.Object<DT>implements java.lang.Runnable</DL>
</PRE>

Copies all data from an input stream to an output stream.

<DL>
<DT>Since:</DT>
 <DD>Ant 1.2</DD>
</DL>
<HR>

<A NAME="constructor_summary"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2">
Constructor Summary</TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/apache/tools/ant/taskdefs/StreamPumper.html#StreamPumper(java.io.InputStream, java.io.OutputStream)">StreamPumper</A>(java.io.InputStream&nbsp;is,
 java.io.OutputStream&nbsp;os)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create a new StreamPumper.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/apache/tools/ant/taskdefs/StreamPumper.html#StreamPumper(java.io.InputStream, java.io.OutputStream, boolean)">StreamPumper</A>(java.io.InputStream&nbsp;is,
 java.io.OutputStream&nbsp;os,
 boolean&nbsp;closeWhenExhausted)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create a new StreamPumper.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/apache/tools/ant/taskdefs/StreamPumper.html#StreamPumper(java.io.InputStream, java.io.OutputStream, boolean, boolean)">StreamPumper</A>(java.io.InputStream&nbsp;is,
 java.io.OutputStream&nbsp;os,
 boolean&nbsp;closeWhenExhausted,
 boolean&nbsp;useAvailable)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create a new StreamPumper.</TD>
</TR>
</TABLE>
&nbsp;

<A NAME="method_summary"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2">
Method Summary</TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;int</CODE></TD>
<TD><CODE><A HREF="../../../../../org/apache/tools/ant/taskdefs/StreamPumper.html#getBufferSize()">getBufferSize</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the size in bytes of the read buffer.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;java.lang.Exception</CODE></TD>
<TD><CODE><A HREF="../../../../../org/apache/tools/ant/taskdefs/StreamPumper.html#getException()">getException</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the exception encountered, if any.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;boolean</CODE></TD>
<TD><CODE><A HREF="../../../../../org/apache/tools/ant/taskdefs/StreamPumper.html#isFinished()">isFinished</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tells whether the end of the stream has been reached.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;void</CODE></TD>
<TD><CODE><A HREF="../../../../../org/apache/tools/ant/taskdefs/StreamPumper.html#run()">run</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Copies data from the input stream to the output stream.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;void</CODE></TD>
<TD><CODE><A HREF="../../../../../org/apache/tools/ant/taskdefs/StreamPumper.html#setBufferSize(int)">setBufferSize</A>(int&nbsp;bufferSize)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the size in bytes of the read buffer.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;void</CODE></TD>
<TD><CODE><A HREF="../../../../../org/apache/tools/ant/taskdefs/StreamPumper.html#waitFor()">waitFor</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method blocks until the StreamPumper finishes.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left">Methods inherited from class java.lang.Object</TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;

<A NAME="constructor_detail"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1">
Constructor Detail</TH>
</TR>
</TABLE>

<A NAME="StreamPumper(java.io.InputStream, java.io.OutputStream, boolean)"></A><H3>
StreamPumper</H3>
<PRE>
public StreamPumper(java.io.InputStream&nbsp;is,
 java.io.OutputStream&nbsp;os,
 boolean&nbsp;closeWhenExhausted)</PRE>
<DL>
<DD>Create a new StreamPumper.

<DL>
<DT>Parameters:<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
 the input is exhausted.</DL>
</DL>
<HR>

<A NAME="StreamPumper(java.io.InputStream, java.io.OutputStream, boolean, boolean)"></A><H3>
StreamPumper</H3>
<PRE>
public StreamPumper(java.io.InputStream&nbsp;is,
 java.io.OutputStream&nbsp;os,
 boolean&nbsp;closeWhenExhausted,
 boolean&nbsp;useAvailable)</PRE>
<DL>
<DD>Create a new StreamPumper.

Note: If you set useAvailable to true, you must
 explicitly invoke <A HREF="../../../../../org/apache/tools/ant/taskdefs/StreamPumper.html#stop()"><CODE>stop</CODE></A> or interrupt the
 corresponding Thread when you are done or the run method will
 never finish on some JVMs (namely those where available returns
 0 on a closed stream). Setting it to true may also impact
 performance negatively. This flag should only be set to true
 if you intend to stop the pumper before the input stream gets
 closed.

<DL>
<DT>Parameters:<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
 the input is exhausted.<DD><CODE>useAvailable</CODE> - whether the pumper should use <CODE>available</CODE> to determine
 whether input is ready, thus trying to emulate
 non-blocking behavior.<DT>Since:</DT>
 <DD>Ant 1.8.0</DD>
</DL>
</DL>
<HR>

<A NAME="StreamPumper(java.io.InputStream, java.io.OutputStream)"></A><H3>
StreamPumper</H3>
<PRE>
public StreamPumper(java.io.InputStream&nbsp;is,
 java.io.OutputStream&nbsp;os)</PRE>
<DL>
<DD>Create a new StreamPumper.

<DL>
<DT>Parameters:<DD><CODE>is</CODE> - input stream to read data from<DD><CODE>os</CODE> - output stream to write data to.</DL>
</DL>

<A NAME="method_detail"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1">
Method Detail</TH>
</TR>
</TABLE>

<A NAME="run()"></A><H3>
run</H3>
<PRE>
public void run()</PRE>
<DL>
<DD>Copies data from the input stream to the output stream.

Terminates as soon as the input stream is closed or an error occurs.

<DD><DL>
<DT>Specified by:<DD><CODE>run</CODE> in interface <CODE>java.lang.Runnable</CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="isFinished()"></A><H3>
isFinished</H3>
<PRE>
public boolean isFinished()</PRE>
<DL>
<DD>Tells whether the end of the stream has been reached.

<DD><DL>
</DL>
</DD>
<DD><DL>

<DT>Returns:<DD>true is the stream has been exhausted.</DL>
</DD>
</DL>
<HR>

<A NAME="waitFor()"></A><H3>
waitFor</H3>
<PRE>
public void waitFor()
 throws java.lang.InterruptedException</PRE>
<DL>
<DD>This method blocks until the StreamPumper finishes.

<DD><DL>
</DL>
</DD>
<DD><DL>

<DT>Throws:
<DD><CODE>java.lang.InterruptedException</CODE> - if interrupted.<DT>See Also:<DD><A HREF="../../../../../org/apache/tools/ant/taskdefs/StreamPumper.html#isFinished()"><CODE>isFinished()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="setBufferSize(int)"></A><H3>
setBufferSize</H3>
<PRE>
public void setBufferSize(int&nbsp;bufferSize)</PRE>
<DL>
<DD>Set the size in bytes of the read buffer.

<DD><DL>
</DL>
</DD>
<DD><DL>
<DT>Parameters:<DD><CODE>bufferSize</CODE> - the buffer size to use.
<DT>Throws:
<DD><CODE>java.lang.IllegalStateException</CODE> - if the StreamPumper is already running.</DL>
</DD>
</DL>
<HR>

<A NAME="getBufferSize()"></A><H3>
getBufferSize</H3>
<PRE>
public int getBufferSize()</PRE>
<DL>
<DD>Get the size in bytes of the read buffer.

<DD><DL>
</DL>
</DD>
<DD><DL>

<DT>Returns:<DD>the int size of the read buffer.</DL>
</DD>
</DL>
<HR>

<A NAME="getException()"></A><H3>
getException</H3>
<PRE>
public java.lang.Exception getException()</PRE>
<DL>
<DD>Get the exception encountered, if any.

<DD><DL>
</DL>
</DD>
<DD><DL>

<DT>Returns:<DD>the Exception encountered.</DL>
</DD>
</DL>

<HR>

<A NAME="navbar_bottom"></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 <TR ALIGN="center" VALIGN="top">
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html">Overview</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html">Package</A>&nbsp;</TD>
 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;Class&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html">Tree</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html">Deprecated</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html">Index</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html">Help</A>&nbsp;</TD>
 </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3>

</TD>
</TR>

</TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3">
 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></TD>
<TD VALIGN="top" CLASS="NavBarCell3">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>

<HR>

</BODY>
</HTML>

Ms-Dos/Windows Unix Write backup

jsp File Browser version 1.2 by www.vonloesch.de