An Iterator that wraps a number of Iterators : Iterator « Collections Data Structure « Java

An Iterator that wraps a number of Iterators

 * Hibernate, Relational Persistence for Idiomatic Java
 * Copyright (c) 2008, Red Hat Middleware LLC or third-party contributors as
 * indicated by the @author tags or express copyright attribution
 * statements applied by the authors.  All third-party contributions are
 * distributed under license by Red Hat Middleware LLC.
 * This copyrighted material is made available to anyone wishing to use, modify,
 * copy, or redistribute it subject to the terms and conditions of the GNU
 * Lesser General Public License, as published by the Free Software Foundation.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
 * for more details.
 * You should have received a copy of the GNU Lesser General Public License
 * along with this distribution; if not, write to:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA

import java.util.Iterator;
import java.util.List;

 * An JoinedIterator is an Iterator that wraps a number of Iterators.
 * This class makes multiple iterators look like one to the caller.
 * When any method from the Iterator interface is called, the JoinedIterator
 * will delegate to a single underlying Iterator. The JoinedIterator will
 * invoke the Iterators in sequence until all Iterators are exhausted.
public class JoinedIterator implements Iterator {

  private static final Iterator[] ITERATORS = {};

  // wrapped iterators
  private Iterator[] iterators;

  // index of current iterator in the wrapped iterators array
  private int currentIteratorIndex;

  // the current iterator
  private Iterator currentIterator;

  // the last used iterator
  private Iterator lastUsedIterator;

  public JoinedIterator(List iterators) {
    this( (Iterator[]) iterators.toArray(ITERATORS) );

  public JoinedIterator(Iterator[] iterators) {
    if( iterators==null )
      throw new NullPointerException("Unexpected NULL iterators argument");
    this.iterators = iterators;

  public JoinedIterator(Iterator first, Iterator second) {
    this( new Iterator[] { first, second } );

  public boolean hasNext() {
    return currentIterator.hasNext();

  public Object next() {

  public void remove() {

  // call this before any Iterator method to make sure that the current Iterator
  // is not exhausted
  protected void updateCurrentIterator() {

    if (currentIterator == null) {
      if( iterators.length==0  ) {
        currentIterator = EmptyIterator.emptyIterator;
      else {
        currentIterator = iterators[0];
      // set last used iterator here, in case the user calls remove
      // before calling hasNext() or next() (although they shouldn't)
      lastUsedIterator = currentIterator;

    while (! currentIterator.hasNext() && currentIteratorIndex < iterators.length - 1) {
      currentIterator = iterators[currentIteratorIndex];

/*   Copyright 2004 BEA Systems, Inc.
*   Licensed under the Apache License, Version 2.0 (the "License");
*   you may not use this file except in compliance with the License.
*   You may obtain a copy of the License at
*   Unless required by applicable law or agreed to in writing, software
*   distributed under the License is distributed on an "AS IS" BASIS,
*   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*   See the License for the specific language governing permissions and
*   limitations under the License.

class EmptyIterator implements java.util.Iterator {
 public static final EmptyIterator emptyIterator = new EmptyIterator();
 public boolean hasNext() { return false; }
 public Object next() { return null; }
 public void remove() {
   throw new UnsupportedOperationException();


Related examples in the same category

1.Listing the Elements of a Collection
2.De-mystify the Iterator interface, showing how to write a simple Iterator for an Array of Objects
3.Iterate over Set
4.Demonstrate iterators.
5.Use the for-each for loop to cycle through a collection.
6.List IteratorList Iterator
7.Iterate a Collection and remove an item (Exception, wrong version)
8.Use an Iterator and remove the item with Iterator.remove()
9.An Iterator wrapper for an Enumeration.
10.EmptyIterator is an iterator which is empty.
11.Implements an java.util.Iterator over any array
12.Treat an Iterator as an Iterable
13.Iterator class for sparse values in an array.
14.Iterator class for values contained in an array range.
15.Array Iterator
16.Cyclic Iteration
17.Create singleton Iterator
18.Empty Iterator
19.An Iterator to iterate over the elements of an array
20.Sorted Iterator
21.Iterator Union of Iterators
22.Iterator Utils
23.Linked Iterator
24.Prefetch Iterator
25.Protects an given iterator by preventing calls to remove().
26.An Iterator that returns the elements of a specified array, or other iterators etc.
27.An Iterator wrapper for an Object[], allow us to deal with all array like structures in a consistent manner.
28.An array iterator
29.Adapt iterator to iterable
30.Static utility methods, classes, and abstract classes for iteration.
31.Iterator Collection
32.Convert Iterable to List
33.A singleton null object Iterator implementation.