X-Git-Url: http://wamblee.org/gitweb/?a=blobdiff_plain;f=system%2Fgeneral%2Fsrc%2Fmain%2Fjava%2Forg%2Fwamblee%2Fsystem%2Fgraph%2FEdgeFactory.java;h=85a3ac0e716d11eb9e2b323f969ea9ea7ceab9a2;hb=8de36ff0206c996baf3ee4adc3e2293b12ff5f39;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..85a3ac0e 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,39 @@
 /*
  * 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); 
+    /**
+     * 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);
 }