(no commit message)

[utils] / system / general / src / main / java / org / wamblee / system / graph / EdgeFactory.java

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 32601e7f9b95114ee4dcd8bd7856127fe3bb3439..b522d20524fc99f42a9c882dfcbd574a48495d49 100644 (file)
--- 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,5 +1,5 @@
 /*
- * Copyright 2008 the original author or authors.
+ * Copyright 2005-2010 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.
@@ -12,11 +12,28 @@
  * 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); 
+    /**
+     * 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);
 }