From 08f129f125e7cf0df8caf063797c366f853b2772 Mon Sep 17 00:00:00 2001
From: Ryan Izard <ryan.izard@bigswitch.com>
Date: Fri, 15 Jul 2016 20:36:44 -0400
Subject: [PATCH] Add Javadoc to PathNode
---
.../core/types/PathNode.java | 18 ++++++++++++++++++
1 file changed, 18 insertions(+)
diff --git a/src/main/java/net/floodlightcontroller/core/types/PathNode.java b/src/main/java/net/floodlightcontroller/core/types/PathNode.java
index da9fde403..cd16ac6f0 100644
--- a/src/main/java/net/floodlightcontroller/core/types/PathNode.java
+++ b/src/main/java/net/floodlightcontroller/core/types/PathNode.java
@@ -3,6 +3,24 @@ package net.floodlightcontroller.core.types;
import org.projectfloodlight.openflow.types.DatapathId;
import org.projectfloodlight.openflow.types.OFPort;
+/**
+ * Simple classes for defining a hop in a path.
+ *
+ * Class PathNode good for tracking hops in
+ * an outer container that guarantees ordering
+ * or for standalone use. It can also be useful
+ * when lookup of specific nodes needs to be
+ * faster than O(n)... lookup time dependent on
+ * containing class.
+ *
+ * Inner class LinkedPathNode useful for chaining
+ * LinkedPathNodes together. Note traversal will
+ * always be O(n), since it's effectively a linked
+ * list.
+ *
+ * @author rizard
+ *
+ */
public class PathNode {
private DatapathId node;
private OFPort in;
--
GitLab