Package ghidra.program.model.reloc

Record Class RelocationResult

java.lang.Object
java.lang.Record
ghidra.program.model.reloc.RelocationResult
Record Components:
status - the relocation status
byteLength - the number of original bytes modified at relocation offset if successfully applied and memory bytes were modified.
public record RelocationResult(Relocation.Status status, int byteLength) extends Record
RelocationResult provides the status and byte-length of a processed relocation during the Program load process. Intended to be used internally by a relocation handler. A positive byte-length is only required for a status of Relocation.Status.APPLIED or Relocation.Status.APPLIED_OTHER. Use if Relocation.Status.UNKNOWN should be avoided and is intended for relocation data upgrades when actual status can not be determined.
Singleton instances are provided for relocations which did not directly results in original loaded memory modification.

  • Field Details

  • Constructor Details

    • RelocationResult

      public RelocationResult(Relocation.Status status, int byteLength)
      Creates an instance of a RelocationResult record class.
      Parameters:
      status - the value for the status record component
      byteLength - the value for the byteLength record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • status

      public Relocation.Status status()
      Returns the value of the status record component.
      Returns:
      the value of the status record component

    • byteLength

      public int byteLength()
      Returns the value of the byteLength record component.
      Returns:
      the value of the byteLength record component