Package org.apache.commons.io.input
Class RandomAccessFileInputStream
- java.lang.Object
-
- java.io.InputStream
-
- org.apache.commons.io.input.AbstractInputStream
-
- org.apache.commons.io.input.RandomAccessFileInputStream
-
- All Implemented Interfaces:
java.io.Closeable
,java.lang.AutoCloseable
public class RandomAccessFileInputStream extends AbstractInputStream
Streams data from aRandomAccessFile
starting at its current position.To build an instance, use
RandomAccessFileInputStream.Builder
.- Since:
- 2.8.0
- See Also:
RandomAccessFileInputStream.Builder
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
RandomAccessFileInputStream.Builder
Builds a newRandomAccessFileInputStream
.
-
Constructor Summary
Constructors Constructor Description RandomAccessFileInputStream(java.io.RandomAccessFile file)
Deprecated.RandomAccessFileInputStream(java.io.RandomAccessFile file, boolean propagateClose)
Deprecated.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description int
available()
Gets an estimate of the number of bytes that can be read (or skipped over) from this input stream.long
availableLong()
Gets the number of bytes that can be read (or skipped over) from this input stream.static RandomAccessFileInputStream.Builder
builder()
Constructs a newRandomAccessFileInputStream.Builder
.void
close()
java.io.RandomAccessFile
getRandomAccessFile()
Gets the underlying file.boolean
isCloseOnClose()
Tests 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 org.apache.commons.io.input.AbstractInputStream
isClosed, setClosed
-
-
-
-
Constructor Detail
-
RandomAccessFileInputStream
@Deprecated public RandomAccessFileInputStream(java.io.RandomAccessFile file)
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 public RandomAccessFileInputStream(java.io.RandomAccessFile file, boolean propagateClose)
Deprecated.Constructs a new instance.- Parameters:
file
- The file to stream.propagateClose
- Whether to close the underlying file when this stream is closed.
-
-
Method Detail
-
builder
public static RandomAccessFileInputStream.Builder builder()
Constructs a newRandomAccessFileInputStream.Builder
.- Returns:
- a new
RandomAccessFileInputStream.Builder
. - Since:
- 2.12.0
-
available
public int available() throws java.io.IOException
Gets 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 classjava.io.InputStream
- Returns:
- An estimate of the number of bytes that can be read.
- Throws:
java.io.IOException
- If an I/O error occurs.
-
availableLong
public long availableLong() throws java.io.IOException
Gets 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:
java.io.IOException
- If an I/O error occurs.
-
close
public void close() throws java.io.IOException
- Specified by:
close
in interfacejava.lang.AutoCloseable
- Specified by:
close
in interfacejava.io.Closeable
- Overrides:
close
in classAbstractInputStream
- Throws:
java.io.IOException
-
getRandomAccessFile
public java.io.RandomAccessFile getRandomAccessFile()
Gets the underlying file.- Returns:
- the underlying file.
-
isCloseOnClose
public boolean isCloseOnClose()
Tests whether to close the underlying file when this stream is closed.- Returns:
- Whether to close the underlying file when this stream is closed.
-
read
public int read() throws java.io.IOException
- Specified by:
read
in classjava.io.InputStream
- Throws:
java.io.IOException
-
read
public int read(byte[] bytes) throws java.io.IOException
- Overrides:
read
in classjava.io.InputStream
- Throws:
java.io.IOException
-
read
public int read(byte[] bytes, int offset, int length) throws java.io.IOException
- Overrides:
read
in classjava.io.InputStream
- Throws:
java.io.IOException
-
skip
public long skip(long skipCount) throws java.io.IOException
- Overrides:
skip
in classjava.io.InputStream
- Throws:
java.io.IOException
-
-