Changeset 12478 in josm for trunk/src/org

Timestamp:

2017-07-16T12:33:37+02:00 (7 years ago)

Author:

Don-vip

Message:

NodeGraph: add javadoc, unit tests

File:

• trunk/src/org/openstreetmap/josm/data/osm/NodeGraph.java (modified) (5 diffs)

trunk/src/org/openstreetmap/josm/data/osm/NodeGraph.java

@@ -21 +21 @@
  */
 public class NodeGraph {
+
+    /**
+     * Builds a list of pair of nodes from the given way.
+     * @param way way
+     * @param directed if {@code true} each pair of nodes will occur once, in the way nodes order.
+     *                 if {@code false} each pair of nodes will occur twice (the pair and its inversed copy)
+     * @return a list of pair of nodes from the given way
+     */
     public static List<NodePair> buildNodePairs(Way way, boolean directed) {
         List<NodePair> pairs = new ArrayList<>();
@@ -32 +40 @@
     }
 
+    /**
+     * Builds a list of pair of nodes from the given ways.
+     * @param ways ways
+     * @param directed if {@code true} each pair of nodes will occur once, in the way nodes order.
+     *                 if {@code false} each pair of nodes will occur twice (the pair and its inversed copy)
+     * @return a list of pair of nodes from the given ways
+     */
     public static List<NodePair> buildNodePairs(List<Way> ways, boolean directed) {
         List<NodePair> pairs = new ArrayList<>();
@@ -40 +55 @@
     }
 
+    /**
+     * Builds a new list of pair nodes without the duplicated pairs (including inversed copies).
+     * @param pairs existing list of pairs
+     * @return a new list of pair nodes without the duplicated pairs
+     */
     public static List<NodePair> eliminateDuplicateNodePairs(List<NodePair> pairs) {
         List<NodePair> cleaned = new ArrayList<>();
@@ -242 +262 @@
      */
     protected List<Node> buildSpanningPath(Node startNode) {
-        if (startNode == null)
-            return null;
-        Stack<NodePair> path = new Stack<>();
-        Stack<NodePair> nextPairs = new Stack<>();
-        nextPairs.addAll(getOutboundPairs(startNode));
-        while (!nextPairs.isEmpty()) {
-            NodePair cur = nextPairs.pop();
-            if (!path.contains(cur) && !path.contains(cur.swap())) {
-                while (!path.isEmpty() && !path.peek().isPredecessorOf(cur)) {
-                    path.pop();
+        if (startNode != null) {
+            Stack<NodePair> path = new Stack<>();
+            Stack<NodePair> nextPairs = new Stack<>();
+            nextPairs.addAll(getOutboundPairs(startNode));
+            while (!nextPairs.isEmpty()) {
+                NodePair cur = nextPairs.pop();
+                if (!path.contains(cur) && !path.contains(cur.swap())) {
+                    while (!path.isEmpty() && !path.peek().isPredecessorOf(cur)) {
+                        path.pop();
+                    }
+                    path.push(cur);
+                    if (isSpanningWay(path)) return buildPathFromNodePairs(path);
+                    nextPairs.addAll(getOutboundPairs(path.peek()));
                 }
-                path.push(cur);
-                if (isSpanningWay(path)) return buildPathFromNodePairs(path);
-                nextPairs.addAll(getOutboundPairs(path.peek()));
-            }
-        }
-        return null;
+            }
+        }
+        return Collections.emptyList();
     }
 
@@ -280 +300 @@
         for (Node n: nodes) {
             List<Node> path = buildSpanningPath(n);
-            if (path != null)
+            if (!path.isEmpty())
                 return path;
         }