Package ghidra.program.util

# Interface AddressCorrelation

All Known Implementing Classes:
  `LinearDataAddressCorrelation`, `LinearFunctionAddressCorrelation`

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
  `AddressCorrelationRange`
  `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.
  `default String`
  `getName()`
  This method is no longer part of the API.

- ## Method Details

  - ### getCorrelatedDestinationRange

    AddressCorrelationRange 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 there is not address range mapped
    Throws:
      `CancelledException` - if cancelled

  - ### getName

    default String getName()
    This method is no longer part of the API. Leaving a default implementation to reduce breaking clients.
    Returns:
      the simple class name of the implementing class