Package org.apache.commons.io.input
Class QueueInputStream
java.lang.Object
java.io.InputStream
org.apache.commons.io.input.QueueInputStream
- All Implemented Interfaces:
Closeable,AutoCloseable
Simple alternative to JDK
PipedInputStream; queue input stream provides what's written in queue output stream.
To build an instance, use QueueInputStream.Builder.
Example usage:
QueueInputStream inputStream = new QueueInputStream();
QueueOutputStream outputStream = inputStream.newQueueOutputStream();
outputStream.write("hello world".getBytes(UTF_8));
inputStream.read();
Unlike JDK PipedInputStream and PipedOutputStream, queue input/output streams may be used safely in a single thread or multiple threads.
Also, unlike JDK classes, no special meaning is attached to initial or current thread. Instances can be used longer after initial threads exited.
Closing a QueueInputStream has no effect. The methods in this class can be called after the stream has been closed without generating an
IOException.
- Since:
- 2.9.0
- See Also:
-
Nested Class Summary
Nested Classes -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a new instance with no limit to its internal queue size and zero timeout.QueueInputStream(BlockingQueue<Integer> blockingQueue) Deprecated. -
Method Summary
Modifier and TypeMethodDescriptionstatic QueueInputStream.Builderbuilder()Constructs a newQueueInputStream.Builder.Constructs a new QueueOutputStream instance connected to this.intread()Reads and returns a single byte.Methods inherited from class java.io.InputStream
available, close, mark, markSupported, read, read, reset, skip
-
Constructor Details
-
QueueInputStream
public QueueInputStream()Constructs a new instance with no limit to its internal queue size and zero timeout. -
QueueInputStream
Deprecated.Constructs a new instance with given queue and zero timeout.- Parameters:
blockingQueue- backing queue for the stream, null maps to a new blocking queue instance.
-
-
Method Details
-
builder
Constructs a newQueueInputStream.Builder.- Returns:
- a new
QueueInputStream.Builder. - Since:
- 2.12.0
-
newQueueOutputStream
Constructs a new QueueOutputStream instance connected to this. Writes to the output stream will be visible to this input stream.- Returns:
- QueueOutputStream connected to this stream.
-
read
Reads and returns a single byte.- Specified by:
readin classInputStream- Returns:
- the byte read, or
-1if a timeout occurs before a queue element is available. - Throws:
IllegalStateException- if thread is interrupted while waiting.
-
builder(),QueueInputStream.Builder, andQueueInputStream.Builder.get().