Package ghidra.app.util.bin
Class RandomAccessByteProvider
- java.lang.Object
-
- ghidra.app.util.bin.RandomAccessByteProvider
-
- All Implemented Interfaces:
ByteProvider
,java.io.Closeable
,java.lang.AutoCloseable
- Direct Known Subclasses:
RandomAccessMutableByteProvider
@Deprecated(since="10.1", forRemoval=true) public class RandomAccessByteProvider extends java.lang.Object implements ByteProvider
Deprecated, for removal: This API element is subject to removal in a future version.SeeFileByteProvider
as replacement ByteProvider.An implementation of ByteProvider where the underlying bytes are supplied by a random access file.Note: this implementation is not thread-safe, and using an instance of this class from multiple threads will result in reading incorrect data and/or
ArrayIndexOutOfBoundsException
s.See
SynchronizedByteProvider
as a solution.
-
-
Field Summary
Fields Modifier and Type Field Description protected java.io.File
file
Deprecated, for removal: This API element is subject to removal in a future version.protected GhidraRandomAccessFile
randomAccessFile
Deprecated, for removal: This API element is subject to removal in a future version.-
Fields inherited from interface ghidra.app.util.bin.ByteProvider
EMPTY_BYTEPROVIDER
-
-
Constructor Summary
Constructors Constructor Description RandomAccessByteProvider(java.io.File file)
Deprecated, for removal: This API element is subject to removal in a future version.Constructs aByteProvider
using the specifiedFile
.RandomAccessByteProvider(java.io.File file, FSRL fsrl)
Deprecated, for removal: This API element is subject to removal in a future version.RandomAccessByteProvider(java.io.File file, java.lang.String permissions)
Deprecated, for removal: This API element is subject to removal in a future version.Constructs aByteProvider
using the specifiedFile
and permissions
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
close()
Deprecated, for removal: This API element is subject to removal in a future version.Releases any resources theByteProvider
may have occupiedjava.lang.String
getAbsolutePath()
Deprecated, for removal: This API element is subject to removal in a future version.Returns the absolute path (similar to, but not a, URI) to theByteProvider
.java.io.File
getFile()
Deprecated, for removal: This API element is subject to removal in a future version.Returns the underlyingFile
for thisByteProvider
, or null if thisByteProvider
is not associated with aFile
.FSRL
getFSRL()
Deprecated, for removal: This API element is subject to removal in a future version.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)
Deprecated, for removal: This API element is subject to removal in a future version.Returns an input stream to the underlying byte provider starting at the specified index.java.lang.String
getName()
Deprecated, for removal: This API element is subject to removal in a future version.Returns the name of theByteProvider
.boolean
isValidIndex(long index)
Deprecated, for removal: This API element is subject to removal in a future version.Returns true if the specified index is valid.long
length()
Deprecated, for removal: This API element is subject to removal in a future version.Returns the length of theByteProvider
byte
readByte(long index)
Deprecated, for removal: This API element is subject to removal in a future version.Reads a byte at the specified indexbyte[]
readBytes(long index, long length)
Deprecated, for removal: This API element is subject to removal in a future version.Reads a byte array at the specified indexvoid
setFSRL(FSRL fsrl)
Deprecated, for removal: This API element is subject to removal in a future version.Sets theFSRL
of thisByteProvider
java.lang.String
toString()
Deprecated, for removal: This API element is subject to removal in a future version.
-
-
-
Field Detail
-
file
protected java.io.File file
Deprecated, for removal: This API element is subject to removal in a future version.
-
randomAccessFile
protected GhidraRandomAccessFile randomAccessFile
Deprecated, for removal: This API element is subject to removal in a future version.
-
-
Constructor Detail
-
RandomAccessByteProvider
public RandomAccessByteProvider(java.io.File file) throws java.io.IOException
Deprecated, for removal: This API element is subject to removal in a future version.Constructs aByteProvider
using the specifiedFile
.- Parameters:
file
- theFile
to open for random access- Throws:
java.io.IOException
- if theFile
does not exist or other error
-
RandomAccessByteProvider
public RandomAccessByteProvider(java.io.File file, FSRL fsrl) throws java.io.IOException
Deprecated, for removal: This API element is subject to removal in a future version.- Parameters:
file
- theFile
to open for random accessfsrl
- theFSRL
to use for theFile
's path- Throws:
java.io.IOException
- if theFile
does not exist or other error
-
RandomAccessByteProvider
public RandomAccessByteProvider(java.io.File file, java.lang.String permissions) throws java.io.IOException
Deprecated, for removal: This API element is subject to removal in a future version.Constructs aByteProvider
using the specifiedFile
and permissions- Parameters:
file
- theFile
to open for random accesspermissions
- indicating permissions used for open- Throws:
java.io.IOException
- if theFile
does not exist or other error
-
-
Method Detail
-
getFSRL
public FSRL getFSRL()
Deprecated, for removal: This API element is subject to removal in a future version.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
.
-
setFSRL
public void setFSRL(FSRL fsrl)
Deprecated, for removal: This API element is subject to removal in a future version.Sets theFSRL
of thisByteProvider
- Parameters:
fsrl
- theFSRL
to assign to this byte provider
-
getFile
public java.io.File getFile()
Deprecated, for removal: This API element is subject to removal in a future version.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()
Deprecated, for removal: This API element is subject to removal in a future version.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()
Deprecated, for removal: This API element is subject to removal in a future version.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
Deprecated, for removal: This API element is subject to removal in a future version.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
-
close
public void close() throws java.io.IOException
Deprecated, for removal: This API element is subject to removal in a future version.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
- Throws:
java.io.IOException
- if an I/O error occurs
-
length
public long length()
Deprecated, for removal: This API element is subject to removal in a future version.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)
Deprecated, for removal: This API element is subject to removal in a future version.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
Deprecated, for removal: This API element is subject to removal in a future version.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
Deprecated, for removal: This API element is subject to removal in a future version.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
-
toString
public java.lang.String toString()
Deprecated, for removal: This API element is subject to removal in a future version.- Overrides:
toString
in classjava.lang.Object
-
-