Package ghidra.app.util.bin
Class InputStreamByteProvider
java.lang.Object
ghidra.app.util.bin.InputStreamByteProvider
- All Implemented Interfaces:
ByteProvider
,Closeable
,AutoCloseable
A
ByteProvider
implementation that wraps an InputStream
, allowing
data to be read, as long as there are no operations that request data from a previous
offset.
In other words, this ByteProvider
can only be used to read data at ever increasing
offsets.
-
Field Summary
Fields inherited from interface ghidra.app.util.bin.ByteProvider
EMPTY_BYTEPROVIDER
-
Constructor Summary
ConstructorDescriptionInputStreamByteProvider
(InputStream inputStream, long length) Constructs aInputStreamByteProvider
from the specifiedInputStream
-
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Releases any resources theByteProvider
may have occupiedReturns the absolute path (similar to, but not a, URI) to theByteProvider
.getFile()
Returns the underlyingFile
for thisByteProvider
, or null if thisByteProvider
is not associated with aFile
.getInputStream
(long index) Returns an input stream to the underlying byte provider starting at the specified index.getName()
Returns the name of theByteProvider
.boolean
isValidIndex
(long index) Returns true if the specified index is valid.long
length()
Returns the length of theByteProvider
byte
readByte
(long index) Reads a byte at the specified indexbyte[]
readBytes
(long index, long len) Reads a byte array at the specified indexMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface ghidra.app.util.bin.ByteProvider
getFSRL, isEmpty
-
Constructor Details
-
InputStreamByteProvider
Constructs aInputStreamByteProvider
from the specifiedInputStream
- Parameters:
inputStream
- the underlyingInputStream
length
- the length of theInputStreamByteProvider
-
-
Method Details
-
close
public void close()Description copied from interface:ByteProvider
Releases any resources theByteProvider
may have occupied- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceByteProvider
- Specified by:
close
in interfaceCloseable
-
getFile
Description copied from interface:ByteProvider
Returns the underlyingFile
for thisByteProvider
, or null if thisByteProvider
is not associated with aFile
.- Specified by:
getFile
in interfaceByteProvider
- Returns:
- the underlying file for this byte provider
-
getUnderlyingInputStream
-
getInputStream
Description copied from interface:ByteProvider
Returns an input stream to the underlying byte provider starting at the specified index.The caller is responsible for closing the returned
InputStream
instance.If you need to override this default implementation, please document why your inputstream is needed.
- Specified by:
getInputStream
in interfaceByteProvider
- Parameters:
index
- where in theByteProvider
to start theInputStream
- Returns:
- the
InputStream
- Throws:
IOException
- if an I/O error occurs
-
getName
Description copied from interface:ByteProvider
Returns the name of theByteProvider
. For example, the underlying file name.- Specified by:
getName
in interfaceByteProvider
- Returns:
- the name of the
ByteProvider
or null if there is no name
-
getAbsolutePath
Description copied from interface:ByteProvider
Returns the absolute path (similar to, but not a, URI) to theByteProvider
. For example, the complete path to the file.- Specified by:
getAbsolutePath
in interfaceByteProvider
- Returns:
- the absolute path to the
ByteProvider
or null if not associated with aFile
.
-
length
Description copied from interface:ByteProvider
Returns the length of theByteProvider
- Specified by:
length
in interfaceByteProvider
- Returns:
- the length of the
ByteProvider
- Throws:
IOException
- if an I/O error occurs
-
isValidIndex
public boolean isValidIndex(long index) Description copied from interface:ByteProvider
Returns true if the specified index is valid.- Specified by:
isValidIndex
in interfaceByteProvider
- Parameters:
index
- the index in the byte provider to check- Returns:
- true if the specified index is valid
-
readByte
Description copied from interface:ByteProvider
Reads a byte at the specified index- Specified by:
readByte
in interfaceByteProvider
- Parameters:
index
- the index of the byte to read- Returns:
- the byte read from the specified index
- Throws:
IOException
- if an I/O error occurs
-
readBytes
Description copied from interface:ByteProvider
Reads a byte array at the specified index- Specified by:
readBytes
in interfaceByteProvider
- Parameters:
index
- the index of the byte to readlen
- the number of bytes to read- Returns:
- the byte array read from the specified index
- Throws:
IOException
- if an I/O error occurs
-