Package org.apache.commons.io.input
Class ReadAheadInputStream.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<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 newReadAheadInputStream
instance.For example:
ReadAheadInputStream s = ReadAheadInputStream.builder() .setPath(path) .setExecutorService(Executors.newSingleThreadExecutor(ReadAheadInputStream::newThread)) .get();
- Since:
- 2.12.0
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ReadAheadInputStream
get()
Constructs a new instance.ReadAheadInputStream.Builder
setExecutorService(java.util.concurrent.ExecutorService executorService)
Sets the executor service for the read-ahead thread.-
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
-
-
-
-
Method Detail
-
get
public ReadAheadInputStream get() throws java.io.IOException
Constructs a new instance.This builder use the aspects InputStream, OpenOption[], buffer size, ExecutorService.
You must provide an origin that can be converted to an InputStream by this builder, otherwise, this call will throw an
UnsupportedOperationException
.- Returns:
- a new instance.
- Throws:
java.lang.UnsupportedOperationException
- if the origin cannot provide an InputStream.java.io.IOException
- if an I/O error occurs.- See Also:
AbstractStreamBuilder.getInputStream()
-
setExecutorService
public ReadAheadInputStream.Builder setExecutorService(java.util.concurrent.ExecutorService executorService)
Sets the executor service for the read-ahead thread.- Parameters:
executorService
- the executor service for the read-ahead thread.- Returns:
- this
-
-