source code formatting.
[utils] / system / general / src / main / java / org / wamblee / system / graph / DefaultEdge.java
index 24a2c7eb7608b19998f980e02875c16e735a6dba..44e9d522e760f9277c480cae1ab04dc4d5cce4d1 100644 (file)
@@ -1,43 +1,75 @@
 /*
  * 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;
 
+/**
+ * Represents an application-independent edge of a graph.  Applications
+ * might choose to implement the Edge interface directly.
+ *
+ * @author Erik Brakkee
+ */
 public class DefaultEdge implements Edge {
-    
-    private Node _from; 
-    private Node _to; 
-    
-    public DefaultEdge(Node aFrom, Node aTo) { 
-        _from = aFrom;
-        _to = aTo; 
+    /**
+     * DOCUMENT ME!
+     */
+    private Node from;
+
+    /**
+     * DOCUMENT ME!
+     */
+    private Node to;
+
+    /**
+     * Creates a new DefaultEdge object.
+     *
+     * @param aFrom DOCUMENT ME!
+     * @param aTo DOCUMENT ME!
+     */
+    public DefaultEdge(Node aFrom, Node aTo) {
+        from     = aFrom;
+        to       = aTo;
     }
 
+    /**
+     * DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
     @Override
     public Node getFrom() {
-        return _from;
+        return from;
     }
 
+    /**
+     * DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
     @Override
     public Node getTo() {
-        return _to; 
+        return to;
     }
-    
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
     @Override
     public String toString() {
-        return "Edge(" + _from.getName() + ", " + _to.getName() + ")";
+        return "Edge(" + from.getName() + ", " + to.getName() + ")";
     }
-
 }