Method Detail

• static groovy.lang.Tuple2<K, T> findFirstCommonItem(java.util.Iterator<T> refIterator, java.util.Map<K, java.util.Iterator<T>> otherIterators)

  Finds the first item on an iterator that also appears on any of a number of other iterators.

  This could have easily been implemented by Set logic, but the iterators may represent possibly quite long sequences, so we don't want to consume more items than necessary.

  The iterators that are passed in will be (partly) consumed by this method, so the caller should not make any assumptions about their state when the method returns.

  Returns:

  a groovy.lang.Tuple2 that consists of:

  1. the key of the iterator in otherIterators that contained the match;
  2. the common item.

  Returns null if refIterator is disjoint with all otherIterators.

  Parameters:

  refIterator - the iterator with the reference items to look for

  otherIterators - a map containing a number of other iterators as values. The map keys may be used to identify from which iterator the matching item came.

• static groovy.lang.Tuple2<K, T> findFirstCommonItem(java.lang.Iterable<T> ref, java.util.Map<K, ? extends java.lang.Iterable<T>> others)

  Finds the first item in a collection that also appears in any of a number of other collections.

  Returns:

  a groovy.lang.Tuple2 that consists of:

  1. the key of the iterator in otherIterators that contained the match;
  2. the common item.

  Returns null if ref is disjoint with all others.

  Parameters:

  ref - the collection containing the reference items

  others - a java.util.Map containing a number of other collections as values. The map keys may be used to identify from which collection the matching item came

• static T findFirstCommonItem(java.util.Iterator<T> refIterator, java.util.Iterator<T> otherIterator)

  Finds the first item in an iterator that also appears in another iterator.

  Returns:

  the first common item, or null if the two iterators are disjoint

  Parameters:

  ref - the iterator returning the reference items

  others - the iterator to compare with

• static T findFirstCommonItem(java.lang.Iterable<T> ref, java.lang.Iterable<T> other)

  Finds the first item in a collection that also appears in another collection.

  Returns:

  the first common item, or null if the two collections are disjoint

  Parameters:

  ref - the collection containing the reference items

  others - the collection to compare with