Package ghidra.app.util.bin

Class ByteProviderWrapper

java.lang.Object

ghidra.app.util.bin.ByteProviderWrapper

All Implemented Interfaces:

ByteProvider, java.io.Closeable, java.lang.AutoCloseable

public class ByteProviderWrapper
extends java.lang.Object
implements ByteProvider

A ByteProvider constrained to a sub-section of an existing ByteProvider.

Field Summary

Fields inherited from interface ghidra.app.util.bin.ByteProvider

EMPTY_BYTEPROVIDER

Constructor Summary

Constructors

Constructor	Description
ByteProviderWrapper(ByteProvider provider, long subOffset, long subLength)	Constructs a ByteProviderWrapper around the specified ByteProvider, constrained to a subsection of the provider.
ByteProviderWrapper(ByteProvider provider, long subOffset, long subLength, FSRL fsrl)	Constructs a ByteProviderWrapper around the specified ByteProvider, constrained to a subsection of the provider.
ByteProviderWrapper(ByteProvider provider, FSRL fsrl)	Creates a wrapper around a ByteProvider that contains the same bytes as the specified provider, but with a new FSRL identity.

Method Summary

Modifier and Type	Method	Description
void	close()	Releases any resources the ByteProvider may have occupied
java.lang.String	getAbsolutePath()	Returns the absolute path (similar to, but not a, URI) to the ByteProvider.
java.io.File	getFile()	Returns the underlying File for this ByteProvider, or null if this ByteProvider is not associated with a File.
FSRL	getFSRL()	Returns the FSRL of the underlying file for this byte provider, or null if this byte provider is not associated with a file.
java.lang.String	getName()	Returns the name of the ByteProvider.
boolean	isValidIndex(long index)	Returns true if the specified index is valid.
long	length()	Returns the length of the ByteProvider
byte	readByte(long index)	Reads a byte at the specified index
byte[]	readBytes(long index, long length)	Reads a byte array at the specified index

Methods 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

getInputStream

Constructor Detail

ByteProviderWrapper

public ByteProviderWrapper(ByteProvider provider,
                           FSRL fsrl)
                    throws java.io.IOException

Creates a wrapper around a ByteProvider that contains the same bytes as the specified provider, but with a new FSRL identity.

Parameters:

provider - ByteProvider to wrap

fsrl - FSRL identity for the instance

Throws:

java.io.IOException - if error

ByteProviderWrapper

public ByteProviderWrapper(ByteProvider provider,
                           long subOffset,
                           long subLength)

Constructs a ByteProviderWrapper around the specified ByteProvider, constrained to a subsection of the provider.

Parameters:

provider - the ByteProvider to wrap

subOffset - the offset in the ByteProvider of where to start the new ByteProviderWrapper

subLength - the length of the new ByteProviderWrapper

ByteProviderWrapper

public ByteProviderWrapper(ByteProvider provider,
                           long subOffset,
                           long subLength,
                           FSRL fsrl)

Constructs a ByteProviderWrapper around the specified ByteProvider, constrained to a subsection of the provider.

Parameters:

provider - the ByteProvider to wrap

subOffset - the offset in the ByteProvider of where to start the new ByteProviderWrapper

subLength - the length of the new ByteProviderWrapper

fsrl - FSRL identity of the file this ByteProvider represents

Method Detail

close

public void close()
           throws java.io.IOException

Description copied from interface: ByteProvider

Releases any resources the ByteProvider may have occupied

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface ByteProvider

Specified by:

close in interface java.io.Closeable

Throws:

java.io.IOException - if an I/O error occurs

getFSRL

public FSRL getFSRL()

Description copied from interface: ByteProvider

Returns the FSRL of the underlying file for this byte provider, or null if this byte provider is not associated with a file.

Specified by:

getFSRL in interface ByteProvider

Returns:

The FSRL of the underlying File, or null if no associated File.

getFile

public java.io.File getFile()

Description copied from interface: ByteProvider

Returns the underlying File for this ByteProvider, or null if this ByteProvider is not associated with a File.

Specified by:

getFile in interface ByteProvider

Returns:

the underlying file for this byte provider

getName

public java.lang.String getName()

Description copied from interface: ByteProvider

Returns the name of the ByteProvider. For example, the underlying file name.

Specified by:

getName in interface ByteProvider

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 the ByteProvider. For example, the complete path to the file.

Specified by:

getAbsolutePath in interface ByteProvider

Returns:

the absolute path to the ByteProvider or null if not associated with a File.

length

public long length()
            throws java.io.IOException

Description copied from interface: ByteProvider

Returns the length of the ByteProvider

Specified by:

length in interface ByteProvider

Returns:

the length of the ByteProvider

Throws:

java.io.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 interface ByteProvider

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 interface ByteProvider

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 interface ByteProvider

Parameters:

index - the index of the byte to read

length - 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