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.- Since:
- 2.8.0
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs a new instance configured to leave the underlying file open when this stream is closed.RandomAccessFileInputStream
(RandomAccessFile file, boolean closeOnClose) Constructs a new instance. -
Method Summary
Modifier and TypeMethodDescriptionint
Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream.long
Returns the number of bytes that can be read (or skipped over) from this input stream.void
close()
Gets the underlying file.boolean
Returns whether to close the underlying file when this stream is closed.int
read()
int
read
(byte[] bytes) int
read
(byte[] bytes, int offset, int length) long
skip
(long skipCount) Methods inherited from class java.io.InputStream
mark, markSupported, nullInputStream, readAllBytes, readNBytes, readNBytes, reset, skipNBytes, transferTo
-
Constructor Details
-
RandomAccessFileInputStream
Constructs a new instance configured to leave the underlying file open when this stream is closed.- Parameters:
file
- The file to stream.
-
RandomAccessFileInputStream
Constructs a new instance.- Parameters:
file
- The file to stream.closeOnClose
- Whether to close the underlying file when this stream is closed.
-
-
Method Details
-
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_VALUE
bytes available, returnInteger.MAX_VALUE
.- Overrides:
available
in 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:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Overrides:
close
in 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:
read
in classInputStream
- Throws:
IOException
-
read
- Overrides:
read
in classInputStream
- Throws:
IOException
-
read
- Overrides:
read
in classInputStream
- Throws:
IOException
-
skip
- Overrides:
skip
in classInputStream
- Throws:
IOException
-