com.metamx.common.guava.nary

Class SortedMergeIterator<InType,OutType>

java.lang.Object

com.metamx.common.guava.nary.SortedMergeIterator<InType,OutType>

All Implemented Interfaces:

Iterator<OutType>

public class SortedMergeIterator<InType,OutType>
extends Object
implements Iterator<OutType>

A SortedMergeIterator is an Iterator that combines two other Iterators into one. It assumes that the two Iterators are in sorted order and walks through them, passing their values to the BinaryFn in sorted order. If a value appears in one Iterator and not in the other, e.g. if the lhs has a value "1" and the rhs does not, the BinaryFn will be called with "1" for first argument and null for the second argument. Thus, the BinaryFn implementation *must* be aware of nulls.

Constructor Summary

Constructors

Constructor and Description
SortedMergeIterator(Iterator<InType> lhs, Iterator<InType> rhs, Comparator<InType> comparator, BinaryFn<InType,InType,OutType> fn)

Method Summary

Methods

Modifier and Type	Method and Description
static <InType,OutType> SortedMergeIterator<InType,OutType>	create(Iterator<InType> lhs, Iterator<InType> rhs, Comparator<InType> comparator, BinaryFn<InType,InType,OutType> fn)
boolean	hasNext()
OutType	next()
void	remove()

Methods inherited from class java.lang.Object

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

Constructor Detail

SortedMergeIterator

public SortedMergeIterator(Iterator<InType> lhs,
                   Iterator<InType> rhs,
                   Comparator<InType> comparator,
                   BinaryFn<InType,InType,OutType> fn)

Method Detail

create

public static <InType,OutType> SortedMergeIterator<InType,OutType> create(Iterator<InType> lhs,
                                                          Iterator<InType> rhs,
                                                          Comparator<InType> comparator,
                                                          BinaryFn<InType,InType,OutType> fn)

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<OutType>

next

public OutType next()

Specified by:

next in interface Iterator<OutType>

remove

public void remove()

Specified by:

remove in interface Iterator<OutType>