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
instance.For example:
RandomAccessFileInputStream s = RandomAccessFileInputStream.builder() .setPath(path) .setCloseOnClose(true) .get();
- Since:
- 2.12.0
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RandomAccessFileInputStream
get()
Constructs a new instance.RandomAccessFileInputStream.Builder
setCloseOnClose(boolean closeOnClose)
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
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 RandomAccessFileInputStream get() throws java.io.IOException
Constructs a new instance.This builder use the aspects RandomAccessFile or File, and closeOnClose. Only set one of RandomAccessFile or an origin that can be converted to a File.
If RandomAccessFile is not set, then you must provide an origin that can be converted to a File by this builder, otherwise, this call will throw an
UnsupportedOperationException
.- Returns:
- a new instance.
- Throws:
java.lang.IllegalStateException
- if both RandomAccessFile and origin are set.java.lang.UnsupportedOperationException
- if the origin cannot provide a File.java.io.IOException
- if an I/O error occurs.- See Also:
AbstractOrigin.getFile()
-
setCloseOnClose
public RandomAccessFileInputStream.Builder setCloseOnClose(boolean closeOnClose)
Sets whether to close the underlying file when this stream is closed.- Parameters:
closeOnClose
- Whether to close the underlying file when this stream is closed.- Returns:
- this
-
setRandomAccessFile
public RandomAccessFileInputStream.Builder setRandomAccessFile(java.io.RandomAccessFile randomAccessFile)
Sets the RandomAccessFile to stream.- Parameters:
randomAccessFile
- the RandomAccessFile to stream.- Returns:
- this
-
-