Package ghidra.trace.util

Class OverlappingObjectIterator<L,R>

java.lang.Object

generic.util.AbstractPeekableIterator<org.apache.commons.lang3.tuple.Pair<L,R>>

ghidra.trace.util.OverlappingObjectIterator<L,R>

Type Parameters:

L - the type of objects returned by the left iterator

R - the type of objects returned by the right iterator

All Implemented Interfaces:

PeekableIterator<org.apache.commons.lang3.tuple.Pair<L,R>>, Iterator<org.apache.commons.lang3.tuple.Pair<L,R>>

public class OverlappingObjectIterator<L,R>
extends AbstractPeekableIterator<org.apache.commons.lang3.tuple.Pair<L,R>>

An iterator of overlapping objects return from two given iterators.

The given iterators, named left and right, must return objects each having a range attribute. Each iterator must return objects having disjoint ranges, i.e., no two objects from the same iterator may intersect. Each iterator must also return the objects sorted by min address. This iterator will then discover every case where an object from the left iterator overlaps an object from the right iterator, and return a pair for each such instance, in order of min address.

WARNING: To avoid heap pollution, this iterator re-uses the same Pair on each call to AbstractPeekableIterator.next(). If you need to save an overlapping pair, you must copy it.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OverlappingObjectIterator.AddressRangeRanger
static class	OverlappingObjectIterator.CodeUnitRanger
static interface	OverlappingObjectIterator.Ranger<T>	A means of obtaining the range attribute from each object
static class	OverlappingObjectIterator.SnapRangeKeyRanger

Field Summary

Fields

Modifier and Type	Field	Description
static final OverlappingObjectIterator.AddressRangeRanger	ADDRESS_RANGE
static final OverlappingObjectIterator.CodeUnitRanger	CODE_UNIT
static final OverlappingObjectIterator.SnapRangeKeyRanger	SNAP_RANGE_KEY

Fields inherited from class generic.util.AbstractPeekableIterator

next, soughtNext

Constructor Summary

Constructors

Constructor	Description
OverlappingObjectIterator(Iterator<? extends L> left, OverlappingObjectIterator.Ranger<? super L> leftRanger, Iterator<? extends R> right, OverlappingObjectIterator.Ranger<? super R> rightRanger)

Method Summary

Modifier and Type	Method	Description
protected org.apache.commons.lang3.tuple.Pair<L,R>	seekNext()	Find the next element in this iterator, because the client called either AbstractPeekableIterator.next or AbstractPeekableIterator.peek().

Methods inherited from class generic.util.AbstractPeekableIterator

hasNext, next, peek

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Field Details

ADDRESS_RANGE

public static final OverlappingObjectIterator.AddressRangeRanger ADDRESS_RANGE

SNAP_RANGE_KEY

public static final OverlappingObjectIterator.SnapRangeKeyRanger SNAP_RANGE_KEY

CODE_UNIT

public static final OverlappingObjectIterator.CodeUnitRanger CODE_UNIT

Constructor Details

OverlappingObjectIterator

public OverlappingObjectIterator(Iterator<? extends L> left,
 OverlappingObjectIterator.Ranger<? super L> leftRanger,
 Iterator<? extends R> right,
 OverlappingObjectIterator.Ranger<? super R> rightRanger)

Method Details

seekNext

protected org.apache.commons.lang3.tuple.Pair<L,R> seekNext()

Description copied from class: AbstractPeekableIterator

Find the next element in this iterator, because the client called either AbstractPeekableIterator.next or AbstractPeekableIterator.peek().

Specified by:

seekNext in class AbstractPeekableIterator<org.apache.commons.lang3.tuple.Pair<L,R>>

Returns:

the next element