Package ghidra.features.base.memsearch.bytesource

# Interface SearchRegion

All Known Implementing Classes:
  `ProgramSearchRegion`

public interface SearchRegion
Interface to specify a named region within a byte source (Program) that users can select to specify `AddressSetView`s that can be searched.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `AddressSetView`
  `getAddresses(Program program)`
  Returns the set of addresses from a specific program that is associated with this region.
  `String`
  `getDescription()`
  Returns a description of the region.
  `String`
  `getName()`
  The name of the region.
  `boolean`
  `isDefault()`
  Returns true if this region should be included in the default selection of which regions to search.

- ## Method Details

  - ### getName

    String getName()
    The name of the region.
    Returns:
      the name of the region

  - ### getDescription

    String getDescription()
    Returns a description of the region.
    Returns:
      a description of the region

  - ### getAddresses

    AddressSetView getAddresses(Program program)
    Returns the set of addresses from a specific program that is associated with this region.
    Parameters:
      `program` - the program that determines the specific addresses for a named region
    Returns:
      the set of addresses for this region as applied to the given program

  - ### isDefault

    boolean isDefault()
    Returns true if this region should be included in the default selection of which regions to search.
    Returns:
      true if this region should be selected by default