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 new
ReadAheadInputStream
instance.
For example:
ReadAheadInputStream s = ReadAheadInputStream.builder()
.setPath(path)
.setExecutorService(Executors.newSingleThreadExecutor(ReadAheadInputStream::newThread))
.get();
- Since:
- 2.12.0
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionget()
Constructs a new instance.setExecutorService
(ExecutorService executorService) Sets the executor service for the read-ahead thread.Methods inherited from class org.apache.commons.io.build.AbstractStreamBuilder
getBufferSize, getBufferSizeDefault, getCharSequence, getCharset, getCharsetDefault, getInputStream, getOpenOptions, getOutputStream, getPath, getWriter, setBufferSize, setBufferSize, setBufferSizeDefault, setCharset, setCharset, setCharsetDefault, setOpenOptions
Methods inherited from class org.apache.commons.io.build.AbstractOriginSupplier
checkOrigin, getOrigin, hasOrigin, newByteArrayOrigin, newCharSequenceOrigin, newFileOrigin, newFileOrigin, newInputStreamOrigin, newOutputStreamOrigin, newPathOrigin, newPathOrigin, newReaderOrigin, newURIOrigin, newWriterOrigin, setByteArray, setCharSequence, setFile, setFile, setInputStream, setOrigin, setOutputStream, setPath, setPath, 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
-
Field Details
-
executorService
-
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
get
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:
UnsupportedOperationException
- if the origin cannot provide an InputStream.IOException
- if an I/O error occurs.- See Also:
-
setExecutorService
Sets the executor service for the read-ahead thread.- Parameters:
executorService
- the executor service for the read-ahead thread.- Returns:
- this
-