Package ghidra.program.database.code

# Class CommentTypeFilterAddressIterator

java.lang.Object
ghidra.program.database.code.CommentTypeFilterAddressIterator

All Implemented Interfaces:
  `AddressIterator`, `Iterable<Address>`, `Iterator<Address>`

public class CommentTypeFilterAddressIterator extends Object implements AddressIterator
Filters the given address iterator to only return addresses that have a comment of the given type

- ## Field Summary

  ### Fields inherited from interface ghidra.program.model.address.AddressIterator

  `EMPTY_ITERATOR`

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `CommentTypeFilterAddressIterator(Program program, AddressIterator it, CommentType commentType)`
  Constructs a new CommentTypeFilterAddressIterator

- ## Method Summary

  Modifier and Type
  Method
  Description
  `boolean`
  `hasNext()`
  Checks if there is a next address in the iteration.
  `Iterator<Address>`
  `iterator()`
  `Address`
  `next()`
  Get the next address.
  `void`
  `remove()`

  ### Methods inherited from class java.lang.Object

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

  ### Methods inherited from interface java.lang.Iterable

  `forEach, spliterator`

  ### Methods inherited from interface java.util.Iterator

  `forEachRemaining`

- ## Constructor Details

  - ### CommentTypeFilterAddressIterator

    public CommentTypeFilterAddressIterator(Program program, AddressIterator it, CommentType commentType)
    Constructs a new CommentTypeFilterAddressIterator
    Parameters:
      `it` - an address iterator whose items are tested for the comment type.
      `commentType` - the type of comment to search for.

- ## Method Details

  - ### remove

    public void remove()
    Specified by:
      `remove` in interface `Iterator<Address>`

  - ### hasNext

    public boolean hasNext()
    Description copied from interface: `AddressIterator`
    Checks if there is a next address in the iteration.
    Specified by:
      `hasNext` in interface `AddressIterator`
    Specified by:
      `hasNext` in interface `Iterator<Address>`
    Returns:
      true if there is a next address.

  - ### next

    public Address next()
    Description copied from interface: `AddressIterator`
    Get the next address.

    NOTE: This deviates from the standard `Iterator` interface by returning null instead of throwing an exception.

    Specified by:
      `next` in interface `AddressIterator`
    Specified by:
      `next` in interface `Iterator<Address>`
    Returns:
      the next address in the iteration.

  - ### iterator

    public Iterator<Address> iterator()
    Specified by:
      `iterator` in interface `AddressIterator`
    Specified by:
      `iterator` in interface `Iterable<Address>`