Package org.apache.commons.io.input

Class ReadAheadInputStream.Builder

java.lang.Object

org.apache.commons.io.build.AbstractSupplier<ReadAheadInputStream,ReadAheadInputStream.Builder>

org.apache.commons.io.build.AbstractOriginSupplier<ReadAheadInputStream,ReadAheadInputStream.Builder>

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

org.apache.commons.io.input.ReadAheadInputStream.Builder

All Implemented Interfaces:

IOSupplier<ReadAheadInputStream>

Enclosing class:

ReadAheadInputStream

public static class ReadAheadInputStream.Builder
extends AbstractStreamBuilder<ReadAheadInputStream,ReadAheadInputStream.Builder>

Builds a new ReadAheadInputStream.

For example:

 ReadAheadInputStream s = ReadAheadInputStream.builder()
   .setPath(path)
   .setExecutorService(Executors.newSingleThreadExecutor(ReadAheadInputStream::newThread))
   .get();
 

If an ExecutorService is not set, then a single-threaded daemon executor service is used.

Since:

2.12.0

See Also:

• get()

Constructor Summary

Constructors

Constructor	Description
Builder()	Constructs a new builder of ReadAheadInputStream.

Method Summary

Modifier and Type	Method	Description
ReadAheadInputStream	get()	Builds a new ReadAheadInputStream.
ReadAheadInputStream.Builder	setExecutorService(ExecutorService executorService)	Sets the executor service for the read-ahead thread.

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

getBufferSize, getBufferSizeDefault, getByteArray, getChannel, getCharSequence, getCharset, getCharsetDefault, getFile, getInputStream, getOpenOptions, getOutputStream, getPath, getRandomAccessFile, getReader, getWriter, setBufferSize, setBufferSize, setBufferSizeChecker, setBufferSizeDefault, setBufferSizeMax, setCharset, setCharset, setCharsetDefault, setOpenOptions

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

checkOrigin, getOrigin, hasOrigin, newByteArrayOrigin, newChannelOrigin, newCharSequenceOrigin, newFileOrigin, newFileOrigin, newInputStreamOrigin, newOutputStreamOrigin, newPathOrigin, newPathOrigin, newRandomAccessFileOrigin, newRandomAccessFileOrigin, newReaderOrigin, newURIOrigin, newWriterOrigin, setByteArray, setChannel, setCharSequence, setFile, setFile, setInputStream, setOrigin, setOutputStream, setPath, setPath, setRandomAccessFile, setRandomAccessFile, setReader, setURI, setWriter

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

asThis

Methods inherited from class java.lang.Object

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

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

asSupplier, getUnchecked

Constructor Details

Builder

public Builder()

Constructs a new builder of ReadAheadInputStream.

Method Details

get

public ReadAheadInputStream get()
                         throws IOException

Builds a new ReadAheadInputStream.

You must set an aspect that supports AbstractStreamBuilder.getInputStream(), otherwise, this method throws an exception.

This builder uses the following aspects:

• AbstractStreamBuilder.getInputStream() gets the target aspect.
• AbstractStreamBuilder.getBufferSize()
• ExecutorService, if not set, a single-threaded daemon executor service is used.

Returns:

a new instance.

Throws:

IllegalStateException - if the origin is null.

UnsupportedOperationException - if the origin cannot be converted to an InputStream.

IOException - if an I/O error occurs converting to an InputStream using AbstractStreamBuilder.getInputStream().

See Also:

• AbstractStreamBuilder.getInputStream()
• AbstractStreamBuilder.getBufferSize()
• IOSupplier.getUnchecked()

setExecutorService

public ReadAheadInputStream.Builder setExecutorService(ExecutorService executorService)

Sets the executor service for the read-ahead thread.

If not set, a single-threaded daemon executor service is used.

Parameters:

executorService - the executor service for the read-ahead thread, may be null.

Returns:

this instance.