/usr/share/doc/libcommons-net2-java/api/org/apache/commons/net/io/Util.html is in libcommons-net2-java-doc 2.2-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_23) on Wed Oct 19 08:52:36 UTC 2011 -->
<TITLE>
Util (libcommons-net2-java API)
</TITLE>
<META NAME="date" CONTENT="2011-10-19">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Util (libcommons-net2-java API)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<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"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../org/apache/commons/net/io/ToNetASCIIOutputStream.html" title="class in org.apache.commons.net.io"><B>PREV CLASS</B></A>
NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/apache/commons/net/io/Util.html" target="_top"><B>FRAMES</B></A>
<A HREF="Util.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.apache.commons.net.io</FONT>
<BR>
Class Util</H2>
<PRE>
<A HREF="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.commons.net.io.Util</B>
</PRE>
<HR>
<DL>
<DT><PRE>public final class <B>Util</B><DT>extends <A HREF="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL>
</PRE>
<P>
The Util class cannot be instantiated and stores short static convenience
methods that are often quite useful.
<p>
<p>
<P>
<P>
<DL>
<DT><B>Author:</B></DT>
<DD>Daniel F. Savarese</DD>
<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/commons/net/io/CopyStreamException.html" title="class in org.apache.commons.net.io"><CODE>CopyStreamException</CODE></A>,
<A HREF="../../../../../org/apache/commons/net/io/CopyStreamListener.html" title="interface in org.apache.commons.net.io"><CODE>CopyStreamListener</CODE></A>,
<A HREF="../../../../../org/apache/commons/net/io/CopyStreamAdapter.html" title="class in org.apache.commons.net.io"><CODE>CopyStreamAdapter</CODE></A></DL>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/commons/net/io/Util.html#DEFAULT_COPY_BUFFER_SIZE">DEFAULT_COPY_BUFFER_SIZE</A></B></CODE>
<BR>
The default buffer size used by <A HREF="../../../../../org/apache/commons/net/io/Util.html#copyStream(java.io.InputStream, java.io.OutputStream, int, long, org.apache.commons.net.io.CopyStreamListener, boolean)"><CODE>copyStream </CODE></A>
and <A HREF="../../../../../org/apache/commons/net/io/Util.html#copyReader(java.io.Reader, java.io.Writer, int, long, org.apache.commons.net.io.CopyStreamListener)"><CODE>copyReader </CODE></A>.</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<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"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static long</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/commons/net/io/Util.html#copyReader(java.io.Reader, java.io.Writer)">copyReader</A></B>(<A HREF="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</A> source,
<A HREF="file:///usr/share/doc/default-jdk-doc/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</A> dest)</CODE>
<BR>
Same as <code> copyReader(source, dest, DEFAULT_COPY_BUFFER_SIZE); </code></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static long</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/commons/net/io/Util.html#copyReader(java.io.Reader, java.io.Writer, int)">copyReader</A></B>(<A HREF="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</A> source,
<A HREF="file:///usr/share/doc/default-jdk-doc/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</A> dest,
int bufferSize)</CODE>
<BR>
Copies the contents of a Reader to a Writer using a
copy buffer of a given size.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static long</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/commons/net/io/Util.html#copyReader(java.io.Reader, java.io.Writer, int, long, org.apache.commons.net.io.CopyStreamListener)">copyReader</A></B>(<A HREF="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</A> source,
<A HREF="file:///usr/share/doc/default-jdk-doc/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</A> dest,
int bufferSize,
long streamSize,
<A HREF="../../../../../org/apache/commons/net/io/CopyStreamListener.html" title="interface in org.apache.commons.net.io">CopyStreamListener</A> listener)</CODE>
<BR>
Copies the contents of a Reader to a Writer using a
copy buffer of a given size and notifies the provided
CopyStreamListener of the progress of the copy operation by calling
its bytesTransferred(long, int) method after each write to the
destination.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static long</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/commons/net/io/Util.html#copyStream(java.io.InputStream, java.io.OutputStream)">copyStream</A></B>(<A HREF="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</A> source,
<A HREF="file:///usr/share/doc/default-jdk-doc/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A> dest)</CODE>
<BR>
Same as <code> copyStream(source, dest, DEFAULT_COPY_BUFFER_SIZE); </code></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static long</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/commons/net/io/Util.html#copyStream(java.io.InputStream, java.io.OutputStream, int)">copyStream</A></B>(<A HREF="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</A> source,
<A HREF="file:///usr/share/doc/default-jdk-doc/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A> dest,
int bufferSize)</CODE>
<BR>
Copies the contents of an InputStream to an OutputStream using a
copy buffer of a given size.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static long</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/commons/net/io/Util.html#copyStream(java.io.InputStream, java.io.OutputStream, int, long, org.apache.commons.net.io.CopyStreamListener)">copyStream</A></B>(<A HREF="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</A> source,
<A HREF="file:///usr/share/doc/default-jdk-doc/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A> dest,
int bufferSize,
long streamSize,
<A HREF="../../../../../org/apache/commons/net/io/CopyStreamListener.html" title="interface in org.apache.commons.net.io">CopyStreamListener</A> listener)</CODE>
<BR>
Copies the contents of an InputStream to an OutputStream using a
copy buffer of a given size and notifies the provided
CopyStreamListener of the progress of the copy operation by calling
its bytesTransferred(long, int) method after each write to the
destination.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static long</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/commons/net/io/Util.html#copyStream(java.io.InputStream, java.io.OutputStream, int, long, org.apache.commons.net.io.CopyStreamListener, boolean)">copyStream</A></B>(<A HREF="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</A> source,
<A HREF="file:///usr/share/doc/default-jdk-doc/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A> dest,
int bufferSize,
long streamSize,
<A HREF="../../../../../org/apache/commons/net/io/CopyStreamListener.html" title="interface in org.apache.commons.net.io">CopyStreamListener</A> listener,
boolean flush)</CODE>
<BR>
Copies the contents of an InputStream to an OutputStream using a
copy buffer of a given size and notifies the provided
CopyStreamListener of the progress of the copy operation by calling
its bytesTransferred(long, int) method after each write to the
destination.</TD>
</TR>
</TABLE>
<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"><B>Methods inherited from class java.lang.<A HREF="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="DEFAULT_COPY_BUFFER_SIZE"><!-- --></A><H3>
DEFAULT_COPY_BUFFER_SIZE</H3>
<PRE>
public static final int <B>DEFAULT_COPY_BUFFER_SIZE</B></PRE>
<DL>
<DD>The default buffer size used by <A HREF="../../../../../org/apache/commons/net/io/Util.html#copyStream(java.io.InputStream, java.io.OutputStream, int, long, org.apache.commons.net.io.CopyStreamListener, boolean)"><CODE>copyStream </CODE></A>
and <A HREF="../../../../../org/apache/commons/net/io/Util.html#copyReader(java.io.Reader, java.io.Writer, int, long, org.apache.commons.net.io.CopyStreamListener)"><CODE>copyReader </CODE></A>. It's value is 1024.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.commons.net.io.Util.DEFAULT_COPY_BUFFER_SIZE">Constant Field Values</A></DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<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"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="copyStream(java.io.InputStream, java.io.OutputStream, int, long, org.apache.commons.net.io.CopyStreamListener, boolean)"><!-- --></A><H3>
copyStream</H3>
<PRE>
public static final long <B>copyStream</B>(<A HREF="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</A> source,
<A HREF="file:///usr/share/doc/default-jdk-doc/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A> dest,
int bufferSize,
long streamSize,
<A HREF="../../../../../org/apache/commons/net/io/CopyStreamListener.html" title="interface in org.apache.commons.net.io">CopyStreamListener</A> listener,
boolean flush)
throws <A HREF="../../../../../org/apache/commons/net/io/CopyStreamException.html" title="class in org.apache.commons.net.io">CopyStreamException</A></PRE>
<DL>
<DD>Copies the contents of an InputStream to an OutputStream using a
copy buffer of a given size and notifies the provided
CopyStreamListener of the progress of the copy operation by calling
its bytesTransferred(long, int) method after each write to the
destination. If you wish to notify more than one listener you should
use a CopyStreamAdapter as the listener and register the additional
listeners with the CopyStreamAdapter.
<p>
The contents of the InputStream are
read until the end of the stream is reached, but neither the
source nor the destination are closed. You must do this yourself
outside of the method call. The number of bytes read/written is
returned.
<p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>source</CODE> - The source InputStream.<DD><CODE>dest</CODE> - The destination OutputStream.<DD><CODE>bufferSize</CODE> - The number of bytes to buffer during the copy.<DD><CODE>streamSize</CODE> - The number of bytes in the stream being copied.
Should be set to CopyStreamEvent.UNKNOWN_STREAM_SIZE if unknown.<DD><CODE>listener</CODE> - The CopyStreamListener to notify of progress. If
this parameter is null, notification is not attempted.<DD><CODE>flush</CODE> - Whether to flush the output stream after every
write. This is necessary for interactive sessions that rely on
buffered streams. If you don't flush, the data will stay in
the stream buffer.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/commons/net/io/CopyStreamException.html" title="class in org.apache.commons.net.io">CopyStreamException</A></CODE> - If an error occurs while reading from the
source or writing to the destination. The CopyStreamException
will contain the number of bytes confirmed to have been
transferred before an
IOException occurred, and it will also contain the IOException
that caused the error. These values can be retrieved with
the CopyStreamException getTotalBytesTransferred() and
getIOException() methods.</DL>
</DD>
</DL>
<HR>
<A NAME="copyStream(java.io.InputStream, java.io.OutputStream, int, long, org.apache.commons.net.io.CopyStreamListener)"><!-- --></A><H3>
copyStream</H3>
<PRE>
public static final long <B>copyStream</B>(<A HREF="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</A> source,
<A HREF="file:///usr/share/doc/default-jdk-doc/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A> dest,
int bufferSize,
long streamSize,
<A HREF="../../../../../org/apache/commons/net/io/CopyStreamListener.html" title="interface in org.apache.commons.net.io">CopyStreamListener</A> listener)
throws <A HREF="../../../../../org/apache/commons/net/io/CopyStreamException.html" title="class in org.apache.commons.net.io">CopyStreamException</A></PRE>
<DL>
<DD>Copies the contents of an InputStream to an OutputStream using a
copy buffer of a given size and notifies the provided
CopyStreamListener of the progress of the copy operation by calling
its bytesTransferred(long, int) method after each write to the
destination. If you wish to notify more than one listener you should
use a CopyStreamAdapter as the listener and register the additional
listeners with the CopyStreamAdapter.
<p>
The contents of the InputStream are
read until the end of the stream is reached, but neither the
source nor the destination are closed. You must do this yourself
outside of the method call. The number of bytes read/written is
returned.
<p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>source</CODE> - The source InputStream.<DD><CODE>dest</CODE> - The destination OutputStream.<DD><CODE>bufferSize</CODE> - The number of bytes to buffer during the copy.<DD><CODE>streamSize</CODE> - The number of bytes in the stream being copied.
Should be set to CopyStreamEvent.UNKNOWN_STREAM_SIZE if unknown.<DD><CODE>listener</CODE> - The CopyStreamListener to notify of progress. If
this parameter is null, notification is not attempted.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/commons/net/io/CopyStreamException.html" title="class in org.apache.commons.net.io">CopyStreamException</A></CODE> - If an error occurs while reading from the
source or writing to the destination. The CopyStreamException
will contain the number of bytes confirmed to have been
transferred before an
IOException occurred, and it will also contain the IOException
that caused the error. These values can be retrieved with
the CopyStreamException getTotalBytesTransferred() and
getIOException() methods.</DL>
</DD>
</DL>
<HR>
<A NAME="copyStream(java.io.InputStream, java.io.OutputStream, int)"><!-- --></A><H3>
copyStream</H3>
<PRE>
public static final long <B>copyStream</B>(<A HREF="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</A> source,
<A HREF="file:///usr/share/doc/default-jdk-doc/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A> dest,
int bufferSize)
throws <A HREF="../../../../../org/apache/commons/net/io/CopyStreamException.html" title="class in org.apache.commons.net.io">CopyStreamException</A></PRE>
<DL>
<DD>Copies the contents of an InputStream to an OutputStream using a
copy buffer of a given size. The contents of the InputStream are
read until the end of the stream is reached, but neither the
source nor the destination are closed. You must do this yourself
outside of the method call. The number of bytes read/written is
returned.
<p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>source</CODE> - The source InputStream.<DD><CODE>dest</CODE> - The destination OutputStream.
<DT><B>Returns:</B><DD>The number of bytes read/written in the copy operation.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/commons/net/io/CopyStreamException.html" title="class in org.apache.commons.net.io">CopyStreamException</A></CODE> - If an error occurs while reading from the
source or writing to the destination. The CopyStreamException
will contain the number of bytes confirmed to have been
transferred before an
IOException occurred, and it will also contain the IOException
that caused the error. These values can be retrieved with
the CopyStreamException getTotalBytesTransferred() and
getIOException() methods.</DL>
</DD>
</DL>
<HR>
<A NAME="copyStream(java.io.InputStream, java.io.OutputStream)"><!-- --></A><H3>
copyStream</H3>
<PRE>
public static final long <B>copyStream</B>(<A HREF="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</A> source,
<A HREF="file:///usr/share/doc/default-jdk-doc/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A> dest)
throws <A HREF="../../../../../org/apache/commons/net/io/CopyStreamException.html" title="class in org.apache.commons.net.io">CopyStreamException</A></PRE>
<DL>
<DD>Same as <code> copyStream(source, dest, DEFAULT_COPY_BUFFER_SIZE); </code>
<P>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/commons/net/io/CopyStreamException.html" title="class in org.apache.commons.net.io">CopyStreamException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="copyReader(java.io.Reader, java.io.Writer, int, long, org.apache.commons.net.io.CopyStreamListener)"><!-- --></A><H3>
copyReader</H3>
<PRE>
public static final long <B>copyReader</B>(<A HREF="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</A> source,
<A HREF="file:///usr/share/doc/default-jdk-doc/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</A> dest,
int bufferSize,
long streamSize,
<A HREF="../../../../../org/apache/commons/net/io/CopyStreamListener.html" title="interface in org.apache.commons.net.io">CopyStreamListener</A> listener)
throws <A HREF="../../../../../org/apache/commons/net/io/CopyStreamException.html" title="class in org.apache.commons.net.io">CopyStreamException</A></PRE>
<DL>
<DD>Copies the contents of a Reader to a Writer using a
copy buffer of a given size and notifies the provided
CopyStreamListener of the progress of the copy operation by calling
its bytesTransferred(long, int) method after each write to the
destination. If you wish to notify more than one listener you should
use a CopyStreamAdapter as the listener and register the additional
listeners with the CopyStreamAdapter.
<p>
The contents of the Reader are
read until its end is reached, but neither the source nor the
destination are closed. You must do this yourself outside of the
method call. The number of characters read/written is returned.
<p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>source</CODE> - The source Reader.<DD><CODE>dest</CODE> - The destination writer.<DD><CODE>bufferSize</CODE> - The number of characters to buffer during the copy.<DD><CODE>streamSize</CODE> - The number of characters in the stream being copied.
Should be set to CopyStreamEvent.UNKNOWN_STREAM_SIZE if unknown.<DD><CODE>listener</CODE> - The CopyStreamListener to notify of progress. If
this parameter is null, notification is not attempted.
<DT><B>Returns:</B><DD>The number of characters read/written in the copy operation.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/commons/net/io/CopyStreamException.html" title="class in org.apache.commons.net.io">CopyStreamException</A></CODE> - If an error occurs while reading from the
source or writing to the destination. The CopyStreamException
will contain the number of bytes confirmed to have been
transferred before an
IOException occurred, and it will also contain the IOException
that caused the error. These values can be retrieved with
the CopyStreamException getTotalBytesTransferred() and
getIOException() methods.</DL>
</DD>
</DL>
<HR>
<A NAME="copyReader(java.io.Reader, java.io.Writer, int)"><!-- --></A><H3>
copyReader</H3>
<PRE>
public static final long <B>copyReader</B>(<A HREF="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</A> source,
<A HREF="file:///usr/share/doc/default-jdk-doc/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</A> dest,
int bufferSize)
throws <A HREF="../../../../../org/apache/commons/net/io/CopyStreamException.html" title="class in org.apache.commons.net.io">CopyStreamException</A></PRE>
<DL>
<DD>Copies the contents of a Reader to a Writer using a
copy buffer of a given size. The contents of the Reader are
read until its end is reached, but neither the source nor the
destination are closed. You must do this yourself outside of the
method call. The number of characters read/written is returned.
<p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>source</CODE> - The source Reader.<DD><CODE>dest</CODE> - The destination writer.<DD><CODE>bufferSize</CODE> - The number of characters to buffer during the copy.
<DT><B>Returns:</B><DD>The number of characters read/written in the copy operation.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/commons/net/io/CopyStreamException.html" title="class in org.apache.commons.net.io">CopyStreamException</A></CODE> - If an error occurs while reading from the
source or writing to the destination. The CopyStreamException
will contain the number of bytes confirmed to have been
transferred before an
IOException occurred, and it will also contain the IOException
that caused the error. These values can be retrieved with
the CopyStreamException getTotalBytesTransferred() and
getIOException() methods.</DL>
</DD>
</DL>
<HR>
<A NAME="copyReader(java.io.Reader, java.io.Writer)"><!-- --></A><H3>
copyReader</H3>
<PRE>
public static final long <B>copyReader</B>(<A HREF="file:///usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</A> source,
<A HREF="file:///usr/share/doc/default-jdk-doc/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</A> dest)
throws <A HREF="../../../../../org/apache/commons/net/io/CopyStreamException.html" title="class in org.apache.commons.net.io">CopyStreamException</A></PRE>
<DL>
<DD>Same as <code> copyReader(source, dest, DEFAULT_COPY_BUFFER_SIZE); </code>
<P>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/apache/commons/net/io/CopyStreamException.html" title="class in org.apache.commons.net.io">CopyStreamException</A></CODE></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<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"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../org/apache/commons/net/io/ToNetASCIIOutputStream.html" title="class in org.apache.commons.net.io"><B>PREV CLASS</B></A>
NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/apache/commons/net/io/Util.html" target="_top"><B>FRAMES</B></A>
<A HREF="Util.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>
|