/*
 * Generic graph library
 * Copyright (C) 2000,2003,2004 University of Maryland
 * 
 * This library 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.1 of the License, or (at your option) any later version.
 * 
 * This library 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 library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package edu.umd.cs.findbugs.graph;

/**
 * An interface for creating Graph objects,
 * and for copying auxiliary information in vertices and edges.
 */
public interface GraphToolkit
		<
		GraphType extends Graph<EdgeType, VertexType>,
		EdgeType extends GraphEdge<EdgeType, VertexType>,
		VertexType extends GraphVertex<VertexType>
		> {

	/**
	 * Create a new empty graph (no vertices or edges).
	 *
	 * @return the new graph
	 */
	public GraphType createGraph();

	/**
	 * Make a copy of given vertex.
	 *
	 * @param original the vertex to copy
	 * @return an exact duplicate of the vertex
	 */
	public VertexType duplicateVertex(VertexType original);

	/**
	 * Copy auxiliary information from one edge to another.
	 *
	 * @param source the source edge
	 * @param dest   the destination edge
	 */
	public void copyEdge(EdgeType source, EdgeType dest);

}

// vim:ts=4
