/*
 * 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
 */

// $Revision: 1.5 $

package edu.umd.cs.findbugs.graph;

import java.util.Set;

/**
 * Interface for an object which combines a set of vertices into a single
 * composite vertex; for example, after finding strongly connected components.
 */
public interface VertexCombinator<VertexType extends GraphVertex<VertexType>> {
    /**
     * Combine given vertices into a single vertex.
     *
     * @param vertexSet
     *            set of vertices to be combined
     * @return the result of combining the vertices in the set
     */
    public VertexType combineVertices(Set<VertexType> vertexSet);
}

