????
Your IP : 216.73.216.152
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_03) on Tue May 22 06:24:52 CEST 2012 -->
<title>StreamPumper (Apache Ant API)</title>
<meta name="date" content="2012-05-22">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="StreamPumper (Apache Ant API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/tools/ant/taskdefs/SQLExec.Transaction.html" title="class in org.apache.tools.ant.taskdefs"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/tools/ant/taskdefs/SubAnt.html" title="class in org.apache.tools.ant.taskdefs"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/tools/ant/taskdefs/StreamPumper.html" target="_top">Frames</a></li>
<li><a href="StreamPumper.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.tools.ant.taskdefs</div>
<h2 title="Class StreamPumper" class="title">Class StreamPumper</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.tools.ant.taskdefs.StreamPumper</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.lang.Runnable</dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">StreamPumper</span>
extends java.lang.Object
implements java.lang.Runnable</pre>
<div class="block">Copies all data from an input stream to an output stream.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>Ant 1.2</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/StreamPumper.html#StreamPumper(java.io.InputStream, java.io.OutputStream)">StreamPumper</a></strong>(java.io.InputStream is,
java.io.OutputStream os)</code>
<div class="block">Create a new StreamPumper.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/StreamPumper.html#StreamPumper(java.io.InputStream, java.io.OutputStream, boolean)">StreamPumper</a></strong>(java.io.InputStream is,
java.io.OutputStream os,
boolean closeWhenExhausted)</code>
<div class="block">Create a new StreamPumper.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/StreamPumper.html#StreamPumper(java.io.InputStream, java.io.OutputStream, boolean, boolean)">StreamPumper</a></strong>(java.io.InputStream is,
java.io.OutputStream os,
boolean closeWhenExhausted,
boolean useAvailable)</code>
<div class="block">Create a new StreamPumper.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/StreamPumper.html#getBufferSize()">getBufferSize</a></strong>()</code>
<div class="block">Get the size in bytes of the read buffer.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Exception</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/StreamPumper.html#getException()">getException</a></strong>()</code>
<div class="block">Get the exception encountered, if any.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/StreamPumper.html#isFinished()">isFinished</a></strong>()</code>
<div class="block">Tells whether the end of the stream has been reached.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/StreamPumper.html#run()">run</a></strong>()</code>
<div class="block">Copies data from the input stream to the output stream.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/StreamPumper.html#setBufferSize(int)">setBufferSize</a></strong>(int bufferSize)</code>
<div class="block">Set the size in bytes of the read buffer.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/StreamPumper.html#waitFor()">waitFor</a></strong>()</code>
<div class="block">This method blocks until the StreamPumper finishes.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="StreamPumper(java.io.InputStream, java.io.OutputStream, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>StreamPumper</h4>
<pre>public StreamPumper(java.io.InputStream is,
java.io.OutputStream os,
boolean closeWhenExhausted)</pre>
<div class="block">Create a new StreamPumper.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>is</code> - input stream to read data from</dd><dd><code>os</code> - output stream to write data to.</dd><dd><code>closeWhenExhausted</code> - if true, the output stream will be closed when
the input is exhausted.</dd></dl>
</li>
</ul>
<a name="StreamPumper(java.io.InputStream, java.io.OutputStream, boolean, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>StreamPumper</h4>
<pre>public StreamPumper(java.io.InputStream is,
java.io.OutputStream os,
boolean closeWhenExhausted,
boolean useAvailable)</pre>
<div class="block">Create a new StreamPumper.
<p><b>Note:</b> 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.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>is</code> - input stream to read data from</dd><dd><code>os</code> - output stream to write data to.</dd><dd><code>closeWhenExhausted</code> - if true, the output stream will be closed when
the input is exhausted.</dd><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.</dd><dt><span class="strong">Since:</span></dt>
<dd>Ant 1.8.0</dd></dl>
</li>
</ul>
<a name="StreamPumper(java.io.InputStream, java.io.OutputStream)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>StreamPumper</h4>
<pre>public StreamPumper(java.io.InputStream is,
java.io.OutputStream os)</pre>
<div class="block">Create a new StreamPumper.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>is</code> - input stream to read data from</dd><dd><code>os</code> - output stream to write data to.</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="run()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>run</h4>
<pre>public void run()</pre>
<div class="block">Copies data from the input stream to the output stream.
Terminates as soon as the input stream is closed or an error occurs.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>run</code> in interface <code>java.lang.Runnable</code></dd>
</dl>
</li>
</ul>
<a name="isFinished()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isFinished</h4>
<pre>public boolean isFinished()</pre>
<div class="block">Tells whether the end of the stream has been reached.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true is the stream has been exhausted.</dd></dl>
</li>
</ul>
<a name="waitFor()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>waitFor</h4>
<pre>public void waitFor()
throws java.lang.InterruptedException</pre>
<div class="block">This method blocks until the StreamPumper finishes.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.InterruptedException</code> - if interrupted.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/tools/ant/taskdefs/StreamPumper.html#isFinished()"><code>isFinished()</code></a></dd></dl>
</li>
</ul>
<a name="setBufferSize(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBufferSize</h4>
<pre>public void setBufferSize(int bufferSize)</pre>
<div class="block">Set the size in bytes of the read buffer.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>bufferSize</code> - the buffer size to use.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if the StreamPumper is already running.</dd></dl>
</li>
</ul>
<a name="getBufferSize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBufferSize</h4>
<pre>public int getBufferSize()</pre>
<div class="block">Get the size in bytes of the read buffer.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the int size of the read buffer.</dd></dl>
</li>
</ul>
<a name="getException()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getException</h4>
<pre>public java.lang.Exception getException()</pre>
<div class="block">Get the exception encountered, if any.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the Exception encountered.</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/tools/ant/taskdefs/SQLExec.Transaction.html" title="class in org.apache.tools.ant.taskdefs"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/tools/ant/taskdefs/SubAnt.html" title="class in org.apache.tools.ant.taskdefs"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/tools/ant/taskdefs/StreamPumper.html" target="_top">Frames</a></li>
<li><a href="StreamPumper.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>