Package org.apache.commons.io.input
Class RandomAccessFileInputStream
java.lang.Object
java.io.InputStream
org.apache.commons.io.input.RandomAccessFileInputStream
- All Implemented Interfaces:
Closeable,AutoCloseable
Streams data from a
RandomAccessFile starting at its current position.
To build an instance, use RandomAccessFileInputStream.Builder.
- Since:
- 2.8.0
- See Also:
-
Nested Class Summary
Nested Classes -
Constructor Summary
ConstructorsConstructorDescriptionDeprecated.RandomAccessFileInputStream(RandomAccessFile file, boolean closeOnClose) Deprecated. -
Method Summary
Modifier and TypeMethodDescriptionintReturns an estimate of the number of bytes that can be read (or skipped over) from this input stream.longReturns the number of bytes that can be read (or skipped over) from this input stream.builder()Constructs a newRandomAccessFileInputStream.Builder.voidclose()Gets the underlying file.booleanReturns whether to close the underlying file when this stream is closed.intread()intread(byte[] bytes) intread(byte[] bytes, int offset, int length) longskip(long skipCount) Methods inherited from class java.io.InputStream
mark, markSupported, reset
-
Constructor Details
-
RandomAccessFileInputStream
Deprecated.Constructs a new instance configured to leave the underlying file open when this stream is closed.- Parameters:
file- The file to stream.
-
RandomAccessFileInputStream
Deprecated.Constructs a new instance.- Parameters:
file- The file to stream.closeOnClose- Whether to close the underlying file when this stream is closed.
-
-
Method Details
-
builder
Constructs a newRandomAccessFileInputStream.Builder.- Returns:
- a new
RandomAccessFileInputStream.Builder. - Since:
- 2.12.0
-
available
Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream. If there are more thanInteger.MAX_VALUEbytes available, returnInteger.MAX_VALUE.- Overrides:
availablein classInputStream- Returns:
- An estimate of the number of bytes that can be read.
- Throws:
IOException- If an I/O error occurs.
-
availableLong
Returns the number of bytes that can be read (or skipped over) from this input stream.- Returns:
- The number of bytes that can be read.
- Throws:
IOException- If an I/O error occurs.
-
close
- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Overrides:
closein classInputStream- Throws:
IOException
-
getRandomAccessFile
Gets the underlying file.- Returns:
- the underlying file.
-
isCloseOnClose
Returns whether to close the underlying file when this stream is closed.- Returns:
- Whether to close the underlying file when this stream is closed.
-
read
- Specified by:
readin classInputStream- Throws:
IOException
-
read
- Overrides:
readin classInputStream- Throws:
IOException
-
read
- Overrides:
readin classInputStream- Throws:
IOException
-
skip
- Overrides:
skipin classInputStream- Throws:
IOException
-
builder(),RandomAccessFileInputStream.Builder, andRandomAccessFileInputStream.Builder.get()