Package ghidra.program.database.code

Class CommentTypeFilterIterator

  • All Implemented Interfaces:
    CodeUnitIterator, java.lang.Iterable<CodeUnit>, java.util.Iterator<CodeUnit>
    public class CommentTypeFilterIterator
extends java.lang.Object
implements CodeUnitIterator
    Filters the given codeUnit iterator to only return codeUnits that have a comment of the given type

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean hasNext()
      Return true if there is a next CodeUnit.
      java.util.Iterator<CodeUnit> iterator()  
      CodeUnit next()
      Get the next CodeUnit or null if no more CodeUnits.
      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

      • CommentTypeFilterIterator

        public CommentTypeFilterIterator​(CodeUnitIterator it,
                                 int commentType)
        Constructs a new CommentTypeFilterIterator
        Parameters:
        it - a codeunit 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<CodeUnit>
        See Also:
        Iterator.remove()

      • next

        public CodeUnit next()
        Description copied from interface: CodeUnitIterator
        Get the next CodeUnit or null if no more CodeUnits.

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

        Specified by:
        next in interface CodeUnitIterator
        Specified by:
        next in interface java.util.Iterator<CodeUnit>
        See Also:
        CodeUnitIterator.next()

      • iterator

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