Package ghidra.program.database.code

Class CommentTypeFilterAddressIterator

  • All Implemented Interfaces:
    AddressIterator, java.lang.Iterable<Address>, java.util.Iterator<Address>
    public class CommentTypeFilterAddressIterator
extends java.lang.Object
implements AddressIterator
    Filters the given address iterator to only return addresses that have a comment of the given type

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean hasNext()
      Checks if there is a next address in the iteration.
      java.util.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 Detail

      • CommentTypeFilterAddressIterator

        public CommentTypeFilterAddressIterator​(Program program,
                                        AddressIterator it,
                                        int 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 Detail

      • remove

        public void remove()
        Specified by:
        remove in interface java.util.Iterator<Address>
        See Also:
        Iterator.remove()

      • 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 java.util.Iterator<Address>
        Returns:
        true if there is a next address.
        See Also:
        ghidra.program.model.listing.AddressIterator#hasNext()

      • next

        public Address next()
        Description copied from interface: AddressIterator
        Get the next address.
        Specified by:
        next in interface AddressIterator
        Specified by:
        next in interface java.util.Iterator<Address>
        Returns:
        the next address in the iteration.
        See Also:
        ghidra.program.model.listing.AddressIterator#next()

      • iterator

        public java.util.Iterator<Address> iterator()
        Specified by:
        iterator in interface java.lang.Iterable<Address>