Package org.apache.commons.io.input
Class RandomAccessFileInputStream.Builder
java.lang.Object
org.apache.commons.io.build.AbstractSupplier<RandomAccessFileInputStream,RandomAccessFileInputStream.Builder>
org.apache.commons.io.build.AbstractOriginSupplier<RandomAccessFileInputStream,RandomAccessFileInputStream.Builder>
org.apache.commons.io.build.AbstractStreamBuilder<RandomAccessFileInputStream,RandomAccessFileInputStream.Builder>
org.apache.commons.io.input.RandomAccessFileInputStream.Builder
- All Implemented Interfaces:
IOSupplier<RandomAccessFileInputStream>
- Enclosing class:
RandomAccessFileInputStream
public static class RandomAccessFileInputStream.Builder
extends AbstractStreamBuilder<RandomAccessFileInputStream,RandomAccessFileInputStream.Builder>
Builds a new
RandomAccessFileInputStream.
For example:
RandomAccessFileInputStream s = RandomAccessFileInputStream.builder()
.setPath(path)
.setCloseOnClose(true)
.get();
- Since:
- 2.12.0
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionget()Builds a newRandomAccessFileInputStream.setCloseOnClose(boolean propagateClose) Sets whether to close the underlying file when this stream is closed, defaults to false for compatibility.setRandomAccessFile(RandomAccessFile randomAccessFile) Sets the RandomAccessFile to stream.Methods inherited from class org.apache.commons.io.build.AbstractStreamBuilder
getBufferSize, getBufferSizeDefault, getCharSequence, getCharset, getCharsetDefault, getFile, getInputStream, getOpenOptions, getOutputStream, getPath, getRandomAccessFile, getReader, getWriter, setBufferSize, setBufferSize, setBufferSizeChecker, setBufferSizeDefault, setBufferSizeMax, setCharset, setCharset, setCharsetDefault, setOpenOptionsMethods inherited from class org.apache.commons.io.build.AbstractOriginSupplier
checkOrigin, getOrigin, hasOrigin, newByteArrayOrigin, newCharSequenceOrigin, newFileOrigin, newFileOrigin, newInputStreamOrigin, newOutputStreamOrigin, newPathOrigin, newPathOrigin, newRandomAccessFileOrigin, newRandomAccessFileOrigin, newReaderOrigin, newURIOrigin, newWriterOrigin, setByteArray, setCharSequence, setFile, setFile, setInputStream, setOrigin, setOutputStream, setPath, setPath, setRandomAccessFile, setReader, setURI, setWriterMethods inherited from class org.apache.commons.io.build.AbstractSupplier
asThisMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.commons.io.function.IOSupplier
asSupplier, getUnchecked
-
Constructor Details
-
Builder
public Builder()Constructs a new builder ofRandomAccessFileInputStream.
-
-
Method Details
-
get
Builds a newRandomAccessFileInputStream.You must set an aspect that supports
RandomAccessFileorFile, otherwise, this method throws an exception. Only set one of RandomAccessFile or an origin that can be converted to a File.This builder uses the following aspects:
RandomAccessFilegets the target aspect.File- closeOnClose
- Returns:
- a new instance.
- Throws:
IllegalStateException- if theoriginisnull.IllegalStateException- if both RandomAccessFile and origin are set.UnsupportedOperationException- if the origin cannot be converted to aRandomAccessFile.IOException- if an I/O error occurs converting to anRandomAccessFileusingAbstractStreamBuilder.getRandomAccessFile().- See Also:
-
setCloseOnClose
Sets whether to close the underlying file when this stream is closed, defaults to false for compatibility.- Parameters:
propagateClose- Whether to close the underlying file when this stream is closed.- Returns:
thisinstance.
-
setRandomAccessFile
Sets the RandomAccessFile to stream.- Overrides:
setRandomAccessFilein classAbstractOriginSupplier<RandomAccessFileInputStream,RandomAccessFileInputStream.Builder> - Parameters:
randomAccessFile- the RandomAccessFile to stream.- Returns:
thisinstance.
-