KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > edu > umd > cs > findbugs > graph > VertexCombinator


1 /*
2  * Generic graph library
3  * Copyright (C) 2000,2003,2004 University of Maryland
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18  */

19
20 // $Revision: 1.5 $
21

22 package edu.umd.cs.findbugs.graph;
23
24 import java.util.Set JavaDoc;
25
26 /**
27  * Interface for an object which combines a set of vertices into
28  * a single composite vertex; for example,
29  * after finding strongly connected components.
30  */

31 public interface VertexCombinator <VertexType extends GraphVertex<VertexType>> {
32     /**
33      * Combine given vertices into a single vertex.
34      *
35      * @param vertexSet set of vertices to be combined
36      * @return the result of combining the vertices in the set
37      */

38     public VertexType combineVertices(Set JavaDoc<VertexType> vertexSet);
39 }
40
41 // vim:ts=4
42
Popular Tags