Package ghidra.framework.store.local

Class LocalDataFileHandle

java.lang.Object
ghidra.framework.store.local.LocalDataFileHandle
All Implemented Interfaces:
DataFileHandle
public class LocalDataFileHandle extends Object implements DataFileHandle
LocalDataFileHandle provides random access to a local File.

  • Constructor Summary

    Constructors
    Constructor
    Description
    LocalDataFileHandle(File file, boolean readOnly)
    Construct and open a local DataFileHandle.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close()
    Closes this random access file stream and releases any system resources associated with the stream.
    boolean
    isReadOnly()
    Returns true if this data file handle is open read-only.
    long
    length()
    Returns the length of this file.
    void
    read(byte[] b)
    Reads b.length bytes from this file into the byte array, starting at the current file pointer.
    void
    read(byte[] b, int off, int len)
    Reads exactly len bytes from this file into the byte array, starting at the current file pointer.
    void
    seek(long pos)
    Sets the file-pointer offset, measured from the beginning of this file, at which the next read or write occurs.
    void
    setLength(long newLength)
    Sets the length of this file.
    int
    skipBytes(int n)
    Attempts to skip over n bytes of input discarding the skipped bytes.
    void
    write(byte[] b)
    Writes b.length bytes from the specified byte array to this file, starting at the current file pointer.
    void
    write(byte[] b, int off, int len)
    Writes len bytes from the specified byte array starting at offset off to this file.
    void
    write(int b)
    Writes the specified byte to this file.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • LocalDataFileHandle

      public LocalDataFileHandle(File file, boolean readOnly) throws IOException
      Construct and open a local DataFileHandle.
      Parameters:
      file - file to be opened
      readOnly - if true resulting handle may only be read.
      Throws:
      FileNotFoundException - if file was not found
      IOException - if an IO Error occurs

  • Method Details

    • read

      public void read(byte[] b) throws IOException
      Description copied from interface: DataFileHandle
      Reads b.length bytes from this file into the byte array, starting at the current file pointer. This method reads repeatedly from the file until the requested number of bytes are read. This method blocks until the requested number of bytes are read, the end of the stream is detected, or an exception is thrown.
      Specified by:
      read in interface DataFileHandle
      Parameters:
      b - the buffer into which the data is read.
      Throws:
      IOException - if an I/O error occurs.

    • read

      public void read(byte[] b, int off, int len) throws IOException
      Description copied from interface: DataFileHandle
      Reads exactly len bytes from this file into the byte array, starting at the current file pointer. This method reads repeatedly from the file until the requested number of bytes are read. This method blocks until the requested number of bytes are read, the end of the stream is detected, or an exception is thrown.
      Specified by:
      read in interface DataFileHandle
      Parameters:
      b - the buffer into which the data is read.
      off - the start offset of the data.
      len - the number of bytes to read.
      Throws:
      IOException - if an I/O error occurs.

    • skipBytes

      public int skipBytes(int n) throws IOException
      Description copied from interface: DataFileHandle
      Attempts to skip over n bytes of input discarding the skipped bytes.

      This method may skip over some smaller number of bytes, possibly zero. This may result from any of a number of conditions; reaching end of file before n bytes have been skipped is only one possibility. This method never throws an EOFException. The actual number of bytes skipped is returned. If n is negative, no bytes are skipped.

      Specified by:
      skipBytes in interface DataFileHandle
      Parameters:
      n - the number of bytes to be skipped.
      Returns:
      the actual number of bytes skipped.
      Throws:
      IOException - if an I/O error occurs.

    • write

      public void write(int b) throws IOException
      Description copied from interface: DataFileHandle
      Writes the specified byte to this file. The write starts at the current file pointer.
      Specified by:
      write in interface DataFileHandle
      Parameters:
      b - the byte to be written.
      Throws:
      IOException - if an I/O error occurs.

    • write

      public void write(byte[] b) throws IOException
      Description copied from interface: DataFileHandle
      Writes b.length bytes from the specified byte array to this file, starting at the current file pointer.
      Specified by:
      write in interface DataFileHandle
      Parameters:
      b - the data.
      Throws:
      IOException - if an I/O error occurs.

    • write

      public void write(byte[] b, int off, int len) throws IOException
      Description copied from interface: DataFileHandle
      Writes len bytes from the specified byte array starting at offset off to this file.
      Specified by:
      write in interface DataFileHandle
      Parameters:
      b - the data.
      off - the start offset in the data.
      len - the number of bytes to write.
      Throws:
      IOException - if an I/O error occurs.

    • seek

      public void seek(long pos) throws IOException
      Description copied from interface: DataFileHandle
      Sets the file-pointer offset, measured from the beginning of this file, at which the next read or write occurs. The offset may be set beyond the end of the file. Setting the offset beyond the end of the file does not change the file length. The file length will change only by writing after the offset has been set beyond the end of the file.
      Specified by:
      seek in interface DataFileHandle
      Parameters:
      pos - the offset position, measured in bytes from the beginning of the file, at which to set the file pointer.
      Throws:
      IOException - if pos is less than 0 or if an I/O error occurs.

    • length

      public long length() throws IOException
      Description copied from interface: DataFileHandle
      Returns the length of this file.
      Specified by:
      length in interface DataFileHandle
      Returns:
      the length of this file, measured in bytes.
      Throws:
      IOException - if an I/O error occurs.

    • setLength

      public void setLength(long newLength) throws IOException
      Description copied from interface: DataFileHandle
      Sets the length of this file.

      If the present length of the file as returned by the length method is greater than the newLength argument then the file will be truncated. In this case, if the file offset as returned by the getFilePointer method is greater then newLength then after this method returns the offset will be equal to newLength.

      If the present length of the file as returned by the length method is smaller than the newLength argument then the file will be extended. In this case, the contents of the extended portion of the file are not defined.

      Specified by:
      setLength in interface DataFileHandle
      Parameters:
      newLength - The desired length of the file
      Throws:
      IOException - If an I/O error occurs

    • close

      public void close() throws IOException
      Description copied from interface: DataFileHandle
      Closes this random access file stream and releases any system resources associated with the stream. A closed random access file cannot perform input or output operations and cannot be reopened.
      Specified by:
      close in interface DataFileHandle
      Throws:
      IOException - if an I/O error occurs.

    • isReadOnly

      public boolean isReadOnly() throws IOException
      Description copied from interface: DataFileHandle
      Returns true if this data file handle is open read-only.
      Specified by:
      isReadOnly in interface DataFileHandle
      Throws:
      IOException - if an I/O error occurs.