Merge "Declare a property for commons-lang version in poms and use it."

[controller.git] / opendaylight / protocol_plugins / openflow / src / main / java / org / opendaylight / controller / protocol_plugin / openflow / IOFStatisticsListener.java

diff --git a/opendaylight/protocol_plugins/openflow/src/main/java/org/opendaylight/controller/protocol_plugin/openflow/IOFStatisticsListener.java b/opendaylight/protocol_plugins/openflow/src/main/java/org/opendaylight/controller/protocol_plugin/openflow/IOFStatisticsListener.java
index 1c22966299356d1998d2a0cad2aa225ba06504f0..6980479fa82a834340ec82763f7fe10b6b8a26d9 100644 (file)
--- a/opendaylight/protocol_plugins/openflow/src/main/java/org/opendaylight/controller/protocol_plugin/openflow/IOFStatisticsListener.java
+++ b/opendaylight/protocol_plugins/openflow/src/main/java/org/opendaylight/controller/protocol_plugin/openflow/IOFStatisticsListener.java
@@ -5,16 +5,52 @@ import java.util.List;
 import org.openflow.protocol.statistics.OFStatistics;
 
 /**
- * Interface defines the api which gets called when the information
- * contained in the OF statistics reply message from a network is updated with
- * new one.
+ * Interface which defines the notification functions which will get called when
+ * the information contained in the OF statistics reply message received from a
+ * network node is different from the cached one.
  */
 public interface IOFStatisticsListener {
+    /**
+     * Notifies that a new list of description statistics objects for the given
+     * switch is available
+     *
+     * @param switchId
+     *            The datapath id of the openflow switch
+     * @param description
+     *            The new list of description statistics objects
+     */
     public void descriptionStatisticsRefreshed(Long switchId, List<OFStatistics> description);
 
+    /**
+     * Notifies that a new list of flows statistics objects for the given switch
+     * is available
+     *
+     * @param switchId
+     *            The datapath id of the openflow switch
+     * @param flows
+     *            The new list of flow statistics objects
+     */
     public void flowStatisticsRefreshed(Long switchId, List<OFStatistics> flows);
 
+    /**
+     * Notifies that a new list of port statistics objects for the given switch
+     * is available
+     *
+     * @param switchId
+     *            The datapath id of the openflow switch
+     * @param flows
+     *            The new list of port statistics objects
+     */
     public void portStatisticsRefreshed(Long switchId, List<OFStatistics> ports);
 
+    /**
+     * Notifies that a new list of table statistics objects for the given switch
+     * is available
+     *
+     * @param switchId
+     *            The datapath id of the openflow switch
+     * @param flows
+     *            The new list of table statistics objects
+     */
     public void tableStatisticsRefreshed(Long switchId, List<OFStatistics> tables);
 }