TreeImporter.java

/*
 * TreeImporter.java
 *
 * Copyright (c) 2002-2015 Alexei Drummond, Andrew Rambaut and Marc Suchard
 *
 * This file is part of BEAST.
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership and licensing.
 *
 * BEAST is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 *  BEAST 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 BEAST; if not, write to the
 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
 * Boston, MA  02110-1301  USA
 */

package dr.evolution.io;

import dr.evolution.tree.Tree;
import dr.evolution.util.TaxonList;

import java.io.IOException;

/**
 * Interface for importers that do trees
 *
 * @version $Id: TreeImporter.java,v 1.7 2005/05/24 20:25:56 rambaut Exp $
 *
 * @author Andrew Rambaut
 * @author Alexei Drummond
 */
public interface TreeImporter { 

	/**
	 * return whether another tree is available. 
	 */
	boolean hasTree() throws IOException, Importer.ImportException;

	/**
	 * import the next tree. 
	 * return the tree or null if no more trees are available
	 */
	Tree importNextTree() throws IOException, Importer.ImportException;

	/**
	 * import a single tree. 
	 */
	Tree importTree(TaxonList taxonList) throws IOException, Importer.ImportException;

	/**
	 * import an array of all trees. 
	 */
	Tree[] importTrees(TaxonList taxonList) throws IOException, Importer.ImportException;
}