org.fcrepo.kernel.utils.iterators

Class DifferencingIterator<E>

java.lang.Object

com.google.common.collect.UnmodifiableIterator<T>

com.google.common.collect.AbstractIterator<E>

org.fcrepo.kernel.utils.iterators.DifferencingIterator<E>

Type Parameters:

E - The type of element common to both source and set.

All Implemented Interfaces:

Iterator<E>

public class DifferencingIterator<E>
extends com.google.common.collect.AbstractIterator<E>

A wrapping Iterator that calculates two differences between a Set A and a source Iterator B. The differences are (A - (A ∩ B)) and (B - (A ∩ B)). The ordinary output of this iterator is (B - (A ∩ B)), and after exhaustion, sets containing (A - (A ∩ B)) and (A ∩ B) are available.

Since:

Oct 24, 2013

Author:

ajs6f

Constructor Summary

Constructors

Constructor and Description
DifferencingIterator(Set<? extends E> original, Iterator<E> source) Ordinary constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Set<E>	common() This method will return null until the source iterator is exhausted.
protected E	computeNext()
Set<? extends E>	notCommon() This method will return null until the source iterator is exhausted.

Methods inherited from class com.google.common.collect.AbstractIterator

endOfData, hasNext, next, peek

Methods inherited from class com.google.common.collect.UnmodifiableIterator

remove

Methods inherited from class java.lang.Object

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

Constructor Detail

DifferencingIterator

public DifferencingIterator(Set<? extends E> original,
                    Iterator<E> source)

Ordinary constructor.

Parameters:

original -

source -

Method Detail

computeNext

protected E computeNext()

Specified by:

computeNext in class com.google.common.collect.AbstractIterator<E>

common

public Set<E> common()

This method will return null until the source iterator is exhausted.

Returns:

The elements that turned out to be common to the two inputs.

notCommon

public Set<? extends E> notCommon()

This method will return null until the source iterator is exhausted.

Returns:

The elements that turned out not to be common to the two inputs.