Package ghidra.app.util.bin

Class ByteArrayProvider

  • All Implemented Interfaces:
    ByteProvider, java.io.Closeable, java.lang.AutoCloseable
    public class ByteArrayProvider
extends java.lang.Object
implements ByteProvider
    An implementation of ByteProvider where the underlying bytes are supplied by a byte array.

    NOTE: Use of this class is discouraged when the byte array could be large.

    • Constructor Detail

      • ByteArrayProvider

        public ByteArrayProvider​(byte[] bytes)
        Constructs a ByteArrayProvider using the specified byte array
        Parameters:
        bytes - the underlying byte array

      • ByteArrayProvider

        public ByteArrayProvider​(byte[] bytes,
                         FSRL fsrl)
        Constructs a ByteArrayProvider using the specified byte array
        Parameters:
        bytes - the underlying byte array
        fsrl - FSRL identity of the file

      • ByteArrayProvider

        public ByteArrayProvider​(java.lang.String name,
                         byte[] bytes)
        Constructs a ByteArrayProvider using the specified byte array
        Parameters:
        name - the name of the ByteProvider
        bytes - the underlying byte array

    • Method Detail

      • close

        public void close()
        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

      • 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 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.

      • 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 interface ByteProvider
        Parameters:
        index - where in the ByteProvider to start the InputStream
        Returns:
        the InputStream
        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