X-Git-Url: http://wamblee.org/gitweb/?a=blobdiff_plain;f=system%2Fgeneral%2Fsrc%2Fmain%2Fjava%2Forg%2Fwamblee%2Fsystem%2Fgraph%2FEdgeFactory.java;h=d54c896e676d6ef3919a9bf1da7473d038f5cfa9;hb=89c06d4d52b46c154128c97d6e758fa1f4fc7a6e;hp=32601e7f9b95114ee4dcd8bd7856127fe3bb3439;hpb=436718e7b7ee0bb9f37db496dbde5c011d5f84e3;p=utils

diff --git a/system/general/src/main/java/org/wamblee/system/graph/EdgeFactory.java b/system/general/src/main/java/org/wamblee/system/graph/EdgeFactory.java
index 32601e7f..d54c896e 100644
--- a/system/general/src/main/java/org/wamblee/system/graph/EdgeFactory.java
+++ b/system/general/src/main/java/org/wamblee/system/graph/EdgeFactory.java
@@ -1,22 +1,43 @@
 /*
  * Copyright 2008 the original author or authors.
- * 
+ *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
- * 
+ *
  *      http://www.apache.org/licenses/LICENSE-2.0
- * 
+ *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
- */ 
+ */
 package org.wamblee.system.graph;
 
 import java.util.List;
 
+
+/**
+ * Edge factory used to extend a graph with new edges. 
+ * @author Erik Brakkee
+ *
+ * @param <NodeType> Type of node. 
+ */
 public interface EdgeFactory<NodeType extends Node> {
-    List<Edge> create(NodeType aFrom, NodeType aTo); 
+    /**
+     * DOCUMENT ME!
+     *
+     * @param aFrom DOCUMENT ME!
+     * @param aTo DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
+/**
+     * Computes a number of new edges to be added to the graph. 
+     * @param aFrom From node. 
+     * @param aTo To node. 
+     * @return List of edges from the from to the to node. 
+     */
+    List<Edge> create(NodeType aFrom, NodeType aTo);
 }