Add support for metadata to the Match/Action classes
[controller.git] / opendaylight / sal / api / src / main / java / org / opendaylight / controller / sal / topology / IListenTopoUpdates.java
index b4c44c00d94ba82fdb8b8ac1190321a575e697b7..6850cc6373d0263fdb108bf35b652667c56fa1e0 100644 (file)
@@ -13,24 +13,16 @@ import java.util.List;
 import org.opendaylight.controller.sal.core.Edge;
 
 /**
- * @file   IListenTopoUpdates.java
- *
- * @brief  Topology notifications provided by SAL toward the application
- *
- * For example an application that wants to keep up to date with the
- * updates coming from SAL it will register in the OSGi service
- * registry this interface (on a per-container base) and SAL will call it
- * providing the update
- */
-
-/**
- * Topology notifications provided by SAL toward the application
- * 
+ * This interface defines the methods for topology notifications provided by SAL
+ * toward the application. For example an application that wants to keep up to
+ * date with the updates coming from SAL it will register in the OSGi service
+ * registry. This interface (on a per-container base) and SAL will call it
+ * providing the update.
  */
 public interface IListenTopoUpdates {
     /**
      * 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.
@@ -40,7 +32,7 @@ public interface IListenTopoUpdates {
     /**
      * 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
      */
@@ -49,8 +41,9 @@ public interface IListenTopoUpdates {
     /**
      * 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);
 }