org.neo4j.helpers.collection.CombiningIterator Maven / Gradle / Ivy

Go to download
/**
 * Copyright (c) 2002-2013 "Neo Technology,"
 * Network Engine for Objects in Lund AB [http://neotechnology.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package org.neo4j.helpers.collection;

import java.util.Collections;
import java.util.Iterator;

/**
 * Combining one or more {@link Iterator}s, making them look like they were
 * one big iterator. All iteration/combining is done lazily.
 *
 * @param  the type of items in the iteration.
 */
public class CombiningIterator extends PrefetchingIterator
{
    private Iterator> iterators;
    private Iterator currentIterator;

    public CombiningIterator( Iterable> iterators )
    {
        this.iterators = iterators.iterator();
    }

    public CombiningIterator( T first, Iterator rest )
    {
        this( Collections.>emptyList() );
        this.hasFetchedNext = true;
        this.nextObject = first;
        this.currentIterator = rest;
    }

    @Override
    protected T fetchNextOrNull()
    {
        if ( currentIterator == null || !currentIterator.hasNext() )
        {
            while ( iterators.hasNext() )
            {
                currentIterator = iterators.next();
                if ( currentIterator.hasNext() )
                {
                    break;
                }
            }
        }
        return currentIterator != null && currentIterator.hasNext() ? currentIterator.next() : null;
    }

    protected Iterator currentIterator()
    {
        return currentIterator;
    }
}