Class StreamPumper

java.lang.Object

org.zeroturnaround.exec.stream.StreamPumper

All Implemented Interfaces:

Runnable

public class StreamPumper
extends Object
implements Runnable

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

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	closeWhenExhausted	close the output stream when exhausted
private static final int	DEFAULT_SIZE	the default size of the internal buffer for copying the streams
private boolean	finished	was the end of the stream reached
private final boolean	flushImmediately	flush the output stream after each write
private final InputStream	is	the input stream to pump from
private static final org.slf4j.Logger	log
private final OutputStream	os	the output stream to pmp into
private final int	size	the size of the internal buffer for copying the streams

Constructor Summary

Constructors

Constructor	Description
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, boolean flushImmediately)	Create a new stream pumper.
StreamPumper(InputStream is, OutputStream os, boolean closeWhenExhausted, int size)	Create a new stream pumper.
StreamPumper(InputStream is, OutputStream os, boolean closeWhenExhausted, int size, boolean flushImmediately)	Create a new stream pumper.

Method Summary

Modifier and Type	Method	Description
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 Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

log

private static final org.slf4j.Logger log

DEFAULT_SIZE

private static final int DEFAULT_SIZE

the default size of the internal buffer for copying the streams

See Also:

• Constant Field Values

is

private final InputStream is

the input stream to pump from

os

private final OutputStream os

the output stream to pmp into

size

private final int size

the size of the internal buffer for copying the streams

finished

private boolean finished

was the end of the stream reached

closeWhenExhausted

private final boolean closeWhenExhausted

close the output stream when exhausted

flushImmediately

private final boolean flushImmediately

flush the output stream after each write

Constructor Details

StreamPumper

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

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.

flushImmediately - flush the output stream whenever data was written to it

StreamPumper

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

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

flushImmediately - flush the output stream whenever data was written to it

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 Details

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 - throws when the waiting is interrupted

See Also:

• isFinished()