org.apache.commons.io.input

Class QueueInputStream.Builder

java.lang.Object

org.apache.commons.io.build.AbstractSupplier<T,B>

org.apache.commons.io.build.AbstractOriginSupplier<T,B>

org.apache.commons.io.build.AbstractStreamBuilder<QueueInputStream,QueueInputStream.Builder>

org.apache.commons.io.input.QueueInputStream.Builder

All Implemented Interfaces:

IOSupplier<QueueInputStream>

Enclosing class:

QueueInputStream

public static class QueueInputStream.Builder
extends org.apache.commons.io.build.AbstractStreamBuilder<QueueInputStream,QueueInputStream.Builder>

Builds a new QueueInputStream instance.

For example:

 QueueInputStream s = QueueInputStream.builder()
   .setBlockingQueue(new LinkedBlockingQueue<>())
   .setTimeout(Duration.ZERO)
   .get();
 

Since:

2.12.0

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
QueueInputStream	get() Constructs a new instance.
QueueInputStream.Builder	setBlockingQueue(java.util.concurrent.BlockingQueue<java.lang.Integer> blockingQueue) Sets backing queue for the stream.
QueueInputStream.Builder	setTimeout(java.time.Duration timeout) Sets the polling timeout.

Methods inherited from class org.apache.commons.io.build.AbstractStreamBuilder

getCharset, setBufferSize, setBufferSize, setCharset, setCharset, setOpenOptions

Methods inherited from class org.apache.commons.io.build.AbstractOriginSupplier

setByteArray, setCharSequence, setFile, setFile, setInputStream, setOutputStream, setPath, setPath, setReader, setURI, setWriter

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.commons.io.function.IOSupplier

asSupplier

Constructor Detail

Builder

public Builder()

Method Detail

get

public QueueInputStream get()

Constructs a new instance.

This builder use the aspects BlockingQueue and timeout.

Returns:

a new instance.

setBlockingQueue

public QueueInputStream.Builder setBlockingQueue(java.util.concurrent.BlockingQueue<java.lang.Integer> blockingQueue)

Sets backing queue for the stream.

Parameters:

blockingQueue - backing queue for the stream.

Returns:

this

setTimeout

public QueueInputStream.Builder setTimeout(java.time.Duration timeout)

Sets the polling timeout.

Parameters:

timeout - the polling timeout.

Returns:

this.