Package ghidra.program.util

# Interface AddressCorrelation

All Known Implementing Classes:
  `LinearDataAddressCorrelation`

public interface AddressCorrelation
Interface representing the address mapping for any means of correlating addresses between a source program and a destination program.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `AddressRange`
  `getCorrelatedDestinationRange(Address sourceAddress, TaskMonitor monitor)`
  Returns the AddressRange of a set of addresses in the destination program that correlates to corresponding range in the source program.
  `String`
  `getName()`
  Returns the name of the correlating algorithm.

- ## Method Details

  - ### getCorrelatedDestinationRange

    AddressRange getCorrelatedDestinationRange(Address sourceAddress, TaskMonitor monitor) throws CancelledException
    Returns the AddressRange of a set of addresses in the destination program that correlates to corresponding range in the source program.
    Parameters:
      `sourceAddress` - the source program address
      `monitor` - the task monitor
    Returns:
      the destination program address range, or null if the source program address maps to one that is "deleted" in the destination program
    Throws:
      `CancelledException` - if cancelled

  - ### getName

    String getName()
    Returns the name of the correlating algorithm.
    Returns:
      the name of the correlating algorithm.