OpenFLow plugin & SAL API documentation

[controller.git] / opendaylight / sal / api / src / main / java / org / opendaylight / controller / sal / topology / IPluginOutTopologyService.java

diff --git a/opendaylight/sal/api/src/main/java/org/opendaylight/controller/sal/topology/IPluginOutTopologyService.java b/opendaylight/sal/api/src/main/java/org/opendaylight/controller/sal/topology/IPluginOutTopologyService.java
index b85eec84283ab4c37918bf9916b8c0618a0a2a2b..32851e86f6236cf6932ce982a504d7626caf5d2b 100644 (file)
--- a/opendaylight/sal/api/src/main/java/org/opendaylight/controller/sal/topology/IPluginOutTopologyService.java
+++ b/opendaylight/sal/api/src/main/java/org/opendaylight/controller/sal/topology/IPluginOutTopologyService.java
@@ -9,31 +9,19 @@
 package org.opendaylight.controller.sal.topology;
 
 import java.util.List;
-import java.util.Set;
-
 import org.opendaylight.controller.sal.core.Edge;
-import org.opendaylight.controller.sal.core.Property;
-import org.opendaylight.controller.sal.core.UpdateType;
 
 /**
- * @file   IPluginOutTopologyService.java
- *
- * @brief  Methods that are invoked from Protocol Plugin toward SAL
- *
- * Every time a protocol plugin update the topology, it will call this
- * service provided by SAL so the update can migrate upward toward the
- * applications
- */
-
-/**
- * Methods that are invoked from Protocol Plugin toward SAL
- * 
+ * This interface defines the methods that are invoked from Protocol Plugin
+ * toward SAL. Every time a protocol plugin update the topology, it will call
+ * this service provided by SAL so the update can migrate upward toward the
+ * applications.
  */
 public interface IPluginOutTopologyService {
 
     /**
      * Called to update on Edge in the topology graph
-     * 
+     *
      * @param topoedgeupdateList
      *            List of topoedgeupdates Each topoedgeupdate includes edge, its
      *            Properties ( BandWidth and/or Latency etc) and update type.
@@ -43,16 +31,18 @@ public interface IPluginOutTopologyService {
     /**
      * Called when an Edge utilization is above the safety threshold configured
      * on the controller
-     * 
+     *
      * @param edge
-     */
+      *            The edge which bandwidth usage is above the safety level
+    */
     public void edgeOverUtilized(Edge edge);
 
     /**
      * Called when the Edge utilization is back to normal, below the safety
      * threshold level configured on the controller
-     * 
+     *
      * @param edge
+     *            The edge which bandwidth usage is back to normal
      */
     public void edgeUtilBackToNormal(Edge edge);
 }