Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.commons.exec
Class StreamPumper

    java.lang.Object
      org.apache.commons.exec.StreamPumper

All Implemented Interfaces:
  Runnable

    public class StreamPumper

extends Object
implements Runnable

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

Constructor Summary
`StreamPumper(InputStream is, OutputStream os)` Create a new stream pumper.
`StreamPumper(InputStream is, OutputStream os, boolean closeWhenExhausted)` Create a new stream pumper.
`StreamPumper(InputStream is, OutputStream os, boolean closeWhenExhausted, int size)` Create a new stream pumper.

Method Summary
`boolean` | `isFinished()` Tells whether the end of the stream has been reached.
`void` | `run()` Copies data from the input stream to the output stream.
`void` | `waitFor()` This method blocks until the stream pumper finishes.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### StreamPumper

    public StreamPumper(InputStream is,
                        OutputStream os,
                        boolean closeWhenExhausted)

  Create a new stream pumper.

  Parameters:
    `is` - input stream to read data from
    `os` - output stream to write data to.
    `closeWhenExhausted` - if true, the output stream will be closed when the input is exhausted.

### StreamPumper

    public StreamPumper(InputStream is,
                        OutputStream os,
                        boolean closeWhenExhausted,
                        int size)

  Create a new stream pumper.

  Parameters:
    `is` - input stream to read data from
    `os` - output stream to write data to.
    `closeWhenExhausted` - if true, the output stream will be closed when the input is exhausted.
    `size` - the size of the internal buffer for copying the streams

### StreamPumper

    public StreamPumper(InputStream is,
                        OutputStream os)

  Create a new stream pumper.

  Parameters:
    `is` - input stream to read data from
    `os` - output stream to write data to.

Method Detail

### run

    public void run()

  Copies data from the input stream to the output stream. Terminates as soon as the input stream is closed or an error occurs.

  Specified by:
    `run` in interface `Runnable`

### isFinished

    public boolean isFinished()

  Tells whether the end of the stream has been reached.

  Returns:
    true is the stream has been exhausted.

### waitFor

    public void waitFor()
                 throws InterruptedException

  This method blocks until the stream pumper finishes.

  Throws:
    `InterruptedException`
  See Also:
    `isFinished()`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2001-2009 The Apache Software Foundation. All Rights Reserved.