com.bigdata.relation.accesspath.IMultiSourceCloseableIterator Maven / Gradle / Ivy

Go to download
/**

Copyright (C) SYSTAP, LLC DBA Blazegraph 2006-2016.  All rights reserved.

Contact:
     SYSTAP, LLC DBA Blazegraph
     2501 Calvert ST NW #106
     Washington, DC 20008
     [email protected]

This program 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; version 2 of the License.

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, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/
/*
 * Created on Oct 19, 2010
 */

package com.bigdata.relation.accesspath;

import cutthecrap.utils.striterators.ICloseableIterator;

/**
 * An interface which permits new sources to be attached dynamically. The
 * decision to accept a new source via {@link #add(ICloseableIterator)} or to
 * {@link IMultiSourceCloseableIterator#close()} the iterator must be atomic.
 * In particular, it is illegal for a source to be accepted after the iterator
 * has been closed.
 * 
 * @author Bryan Thompson
 * @version $Id$
 */
public interface IMultiSourceCloseableIterator extends
        ICloseableIterator {

    /**
     * Add a source. If the iterator already reports that it is closed then the
     * new source can not be added and this method will return false.
     * 
     * @param src
     *            The source.
     * @return true iff the source could be added.
     */
    boolean add(ICloseableIterator src);

}