Package org.zeroturnaround.exec.stream
Class StreamPumper
- java.lang.Object
-
- org.zeroturnaround.exec.stream.StreamPumper
-
- All Implemented Interfaces:
java.lang.Runnable
public class StreamPumper extends java.lang.Object implements java.lang.Runnable
Copies all data from an input stream to an output stream.
-
-
Field Summary
Fields Modifier and Type Field Description private boolean
closeWhenExhausted
close the output stream when exhaustedprivate static int
DEFAULT_SIZE
the default size of the internal buffer for copying the streamsprivate boolean
finished
was the end of the stream reachedprivate boolean
flushImmediately
flush the output stream after each writeprivate java.io.InputStream
is
the input stream to pump fromprivate static org.slf4j.Logger
log
private java.io.OutputStream
os
the output stream to pmp intoprivate int
size
the size of the internal buffer for copying the streams
-
Constructor Summary
Constructors Constructor Description StreamPumper(java.io.InputStream is, java.io.OutputStream os)
Create a new stream pumper.StreamPumper(java.io.InputStream is, java.io.OutputStream os, boolean closeWhenExhausted)
Create a new stream pumper.StreamPumper(java.io.InputStream is, java.io.OutputStream os, boolean closeWhenExhausted, boolean flushImmediately)
Create a new stream pumper.StreamPumper(java.io.InputStream is, java.io.OutputStream os, boolean closeWhenExhausted, int size)
Create a new stream pumper.StreamPumper(java.io.InputStream is, java.io.OutputStream os, boolean closeWhenExhausted, int size, boolean flushImmediately)
Create a new stream pumper.
-
Method Summary
All Methods Instance Methods Concrete Methods 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.
-
-
-
Field Detail
-
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 java.io.InputStream is
the input stream to pump from
-
os
private final java.io.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 Detail
-
StreamPumper
public StreamPumper(java.io.InputStream is, java.io.OutputStream os, boolean closeWhenExhausted, boolean flushImmediately)
Create a new stream pumper.- Parameters:
is
- input stream to read data fromos
- 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(java.io.InputStream is, java.io.OutputStream os, boolean closeWhenExhausted, int size, boolean flushImmediately)
Create a new stream pumper.- Parameters:
is
- input stream to read data fromos
- 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 streamsflushImmediately
- flush the output stream whenever data was written to it
-
StreamPumper
public StreamPumper(java.io.InputStream is, java.io.OutputStream os, boolean closeWhenExhausted)
Create a new stream pumper.- Parameters:
is
- input stream to read data fromos
- output stream to write data to.closeWhenExhausted
- if true, the output stream will be closed when the input is exhausted.
-
StreamPumper
public StreamPumper(java.io.InputStream is, java.io.OutputStream os, boolean closeWhenExhausted, int size)
Create a new stream pumper.- Parameters:
is
- input stream to read data fromos
- 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(java.io.InputStream is, java.io.OutputStream os)
Create a new stream pumper.- Parameters:
is
- input stream to read data fromos
- 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 interfacejava.lang.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 java.lang.InterruptedException
This method blocks until the stream pumper finishes.- Throws:
java.lang.InterruptedException
- throws when the waiting is interrupted- See Also:
isFinished()
-
-