Package ghidra.app.util.bin
Class ByteArrayProvider
- java.lang.Object
-
- ghidra.app.util.bin.ByteArrayProvider
-
- All Implemented Interfaces:
ByteProvider
,java.io.Closeable
,java.lang.AutoCloseable
public class ByteArrayProvider extends java.lang.Object implements ByteProvider
An implementation ofByteProvider
where the underlying bytes are supplied by a byte array.NOTE: Use of this class is discouraged when the byte array could be large.
-
-
Field Summary
-
Fields inherited from interface ghidra.app.util.bin.ByteProvider
EMPTY_BYTEPROVIDER
-
-
Constructor Summary
Constructors Constructor Description ByteArrayProvider(byte[] bytes)
Constructs aByteArrayProvider
using the specified byte arrayByteArrayProvider(byte[] bytes, FSRL fsrl)
Constructs aByteArrayProvider
using the specified byte arrayByteArrayProvider(java.lang.String name, byte[] bytes)
Constructs aByteArrayProvider
using the specified byte array
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
close()
Releases any resources theByteProvider
may have occupiedjava.lang.String
getAbsolutePath()
Returns the absolute path (similar to, but not a, URI) to theByteProvider
.java.io.File
getFile()
Returns the underlyingFile
for thisByteProvider
, or null if thisByteProvider
is not associated with aFile
.FSRL
getFSRL()
Returns theFSRL
of the underlying file for this byte provider, or null if this byte provider is not associated with a file.java.io.InputStream
getInputStream(long index)
Returns an input stream to the underlying byte provider starting at the specified index.java.lang.String
getName()
Returns the name of theByteProvider
.void
hardClose()
Releases the byte storage of this instance.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 length)
Reads a byte array at the specified index
-
-
-
Constructor Detail
-
ByteArrayProvider
public ByteArrayProvider(byte[] bytes)
Constructs aByteArrayProvider
using the specified byte array- Parameters:
bytes
- the underlying byte array
-
ByteArrayProvider
public ByteArrayProvider(byte[] bytes, FSRL fsrl)
Constructs aByteArrayProvider
using the specified byte array- Parameters:
bytes
- the underlying byte arrayfsrl
- FSRL identity of the file
-
ByteArrayProvider
public ByteArrayProvider(java.lang.String name, byte[] bytes)
Constructs aByteArrayProvider
using the specified byte array- Parameters:
name
- the name of theByteProvider
bytes
- the underlying byte array
-
-
Method Detail
-
close
public void close()
Description copied from interface:ByteProvider
Releases any resources theByteProvider
may have occupied- Specified by:
close
in interfacejava.lang.AutoCloseable
- Specified by:
close
in interfaceByteProvider
- Specified by:
close
in interfacejava.io.Closeable
-
hardClose
public void hardClose()
Releases the byte storage of this instance.This is separate from the normal close() to avoid changing existing behavior of this class.
-
getFSRL
public FSRL getFSRL()
Description copied from interface:ByteProvider
Returns theFSRL
of the underlying file for this byte provider, or null if this byte provider is not associated with a file.- Specified by:
getFSRL
in interfaceByteProvider
- Returns:
- The
FSRL
of the underlyingFile
, or null if no associatedFile
.
-
getFile
public java.io.File 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
-
getName
public java.lang.String 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
public java.lang.String 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
.
-
getInputStream
public java.io.InputStream getInputStream(long index) throws java.io.IOException
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:
java.io.IOException
- if an I/O error occurs
-
length
public long length()
Description copied from interface:ByteProvider
Returns the length of theByteProvider
- Specified by:
length
in interfaceByteProvider
- Returns:
- the length of the
ByteProvider
-
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
public byte readByte(long index) throws java.io.IOException
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:
java.io.IOException
- if an I/O error occurs
-
readBytes
public byte[] readBytes(long index, long length) throws java.io.IOException
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 readlength
- the number of bytes to read- Returns:
- the byte array read from the specified index
- Throws:
java.io.IOException
- if an I/O error occurs
-
-