Package org.apache.commons.io.input
Class RandomAccessFileInputStream.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<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 newRandomAccessFileInputStream
.For example:
RandomAccessFileInputStream s = RandomAccessFileInputStream.builder() .setPath(path) .setCloseOnClose(true) .get();
- Since:
- 2.12.0
- See Also:
get()
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RandomAccessFileInputStream
get()
Builds a newRandomAccessFileInputStream
.RandomAccessFileInputStream.Builder
setCloseOnClose(boolean propagateClose)
Sets whether to close the underlying file when this stream is closed.RandomAccessFileInputStream.Builder
setRandomAccessFile(java.io.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, setOpenOptions
-
Methods 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, 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 Detail
-
Builder
public Builder()
-
-
Method Detail
-
get
public RandomAccessFileInputStream get() throws java.io.IOException
Builds a newRandomAccessFileInputStream
.You must set input that supports
RandomAccessFile
orFile
, otherwise, this method throws an exception. Only set one of RandomAccessFile or an origin that can be converted to a File.This builder use the following aspects:
RandomAccessFile
File
- closeOnClose
- Returns:
- a new instance.
- Throws:
java.lang.IllegalStateException
- if theorigin
isnull
.java.lang.IllegalStateException
- if both RandomAccessFile and origin are set.java.lang.UnsupportedOperationException
- if the origin cannot be converted to aFile
.java.io.IOException
- if an I/O error occurs.- See Also:
AbstractOrigin.getFile()
-
setCloseOnClose
public RandomAccessFileInputStream.Builder setCloseOnClose(boolean propagateClose)
Sets whether to close the underlying file when this stream is closed.- Parameters:
propagateClose
- Whether to close the underlying file when this stream is closed.- Returns:
this
instance.
-
setRandomAccessFile
public RandomAccessFileInputStream.Builder setRandomAccessFile(java.io.RandomAccessFile randomAccessFile)
Sets the RandomAccessFile to stream.- Overrides:
setRandomAccessFile
in classAbstractOriginSupplier<RandomAccessFileInputStream,RandomAccessFileInputStream.Builder>
- Parameters:
randomAccessFile
- the RandomAccessFile to stream.- Returns:
this
instance.
-
-