Fix NPE in FlowProgrammerService in openflow plugin

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

diff --git a/opendaylight/protocol_plugins/openflow/src/main/java/org/opendaylight/controller/protocol_plugin/openflow/IReadServiceFilter.java b/opendaylight/protocol_plugins/openflow/src/main/java/org/opendaylight/controller/protocol_plugin/openflow/IReadServiceFilter.java
index a10e22b394c6c3e3d741367c588959a26ca332ba..9ba67e382f9b41f7a7428fab37116e678c286d39 100644 (file)
--- a/opendaylight/protocol_plugins/openflow/src/main/java/org/opendaylight/controller/protocol_plugin/openflow/IReadServiceFilter.java
+++ b/opendaylight/protocol_plugins/openflow/src/main/java/org/opendaylight/controller/protocol_plugin/openflow/IReadServiceFilter.java
@@ -1,4 +1,3 @@
-
 /*
  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
  *
@@ -21,90 +20,139 @@ import org.opendaylight.controller.sal.reader.NodeDescription;
 import org.opendaylight.controller.sal.reader.NodeTableStatistics;
 
 /**
- * Interface to serve the hardware information requests coming from SAL
- * It is implemented by the respective OF1.0 plugin component
+ * Interface to serve the hardware information requests coming from SAL It is
+ * implemented by the respective OF1.0 plugin component
  *
  */
 public interface IReadServiceFilter {
     /**
-     * Returns the hardware image for the specified flow
-     * on the specified network node for the passed container
+     * Returns the hardware image for the specified flow on the specified
+     * network node for the passed container
      *
      * @param container
+     *            the container for which the request is originated
      * @param node
+     *            the network node
      * @param flow
+     *            the target flow
      * @param cached
-     * @return
+     *            specify if entry has to be queried from the cached hardware
+     *            information maintained in the protocol plugin or directly from
+     *            the network node.
+     * @return The FlowOnNode object containing the information present in
+     *         hardware for the passed flow on the specified network node
      */
-    public FlowOnNode readFlow(String container, Node node, Flow flow,
-            boolean cached);
+    public FlowOnNode readFlow(String container, Node node, Flow flow, boolean cached);
 
     /**
-     * Returns the hardware view of all the flow installed
-     * on the specified network node for the passed container
+     * Returns the hardware view of all the flow installed on the specified
+     * network node for the passed container
      *
      * @param container
+     *            the container for which the request is originated
      * @param node
+     *            the network node
      * @param cached
-     * @return
+     *            specify if entries have to be queried from the cached hardware
+     *            information maintained in the protocol plugin or directly from
+     *            the network node.
+     * @return The list of FlowOnNode objects containing the information present
+     *         in hardware on the specified network node for all its flows
      */
-    public List<FlowOnNode> readAllFlow(String container, Node node,
-            boolean cached);
+    public List<FlowOnNode> readAllFlow(String container, Node node, boolean cached);
 
     /**
-     * Returns the description of the network node as provided by the node itself
+     * Returns the description of the network node as provided by the node
+     * itself
      *
      * @param node
+     *            the network node
      * @param cached
-     * @return
+     *            specify if entry has to be queried from the cached hardware
+     *            information maintained in the protocol plugin or directly from
+     *            the network node.
+     * @return The NodeDescription object containing the description information
+     *         for the specified network node
      */
     public NodeDescription readDescription(Node node, boolean cached);
 
     /**
-     * Returns the hardware view of the specified network node connector
-     * for the given container
-     * @param node
-     * @return
+     * Returns the hardware view of the specified network node connector for the
+     * given container
+     *
+     * @param container
+     *            the container for which the request is originated
+     * @param nodeConnector
+     *            the target nodeConnector
+     * @param cached
+     *            specify if entry has to be queried from the cached hardware
+     *            information maintained in the protocol plugin or directly from
+     *            the corresponding network node.
+     * @return The NodeConnectorStatistics object containing the statistics
+     *         present in hardware for the corresponding network node port
      */
-    public NodeConnectorStatistics readNodeConnector(String container,
-            NodeConnector nodeConnector, boolean cached);
+    public NodeConnectorStatistics readNodeConnector(String container, NodeConnector nodeConnector, boolean cached);
 
     /**
-     * Returns the hardware info for all the node connectors on the
-     * specified network node for the given container
+     * Returns the hardware info for all the node connectors on the specified
+     * network node for the given container
      *
+     * @param container
+     *            the container for which the request is originated
      * @param node
-     * @return
+     *            the target node
+     * @param cached
+     *            specify if entries have to be queried from the cached hardware
+     *            information maintained in the protocol plugin or directly from
+     *            the corresponding network node.
+     * @return The list of NodeConnectorStatistics objects containing the
+     *         statistics present in hardware for all the network node ports
      */
-    public List<NodeConnectorStatistics> readAllNodeConnector(String container,
-            Node node, boolean cached);
+    public List<NodeConnectorStatistics> readAllNodeConnector(String container, Node node, boolean cached);
 
     /**
-     * Returns the table statistics of the node as specified by the given container
-     * @param node
+     * Returns the table statistics of the node as specified by the given
+     * container
+     *
+     * @param container
+     *            the container for which the request is originated
+     * @param nodeTable
+     *            the target network node table
      * @param cached
-     * @return
+     *            specify if entry has to be queried from the cached hardware
+     *            information maintained in the protocol plugin or directly from
+     *            the corresponding network node.
+     * @return The NodeTableStatistics object containing the statistics present
+     *         in hardware for the corresponding network node table
      */
-    public NodeTableStatistics readNodeTable(String container,
-            NodeTable nodeTable, boolean cached);
+    public NodeTableStatistics readNodeTable(String container, NodeTable nodeTable, boolean cached);
 
     /**
      * Returns the table statistics of all the tables for the specified node
      *
+     * @param container
+     *            the container for which the request is originated
      * @param node
-     * @return
+     *            the target node
+     * @param cached
+     *            specify if entries have to be queried from the cached hardware
+     *            information maintained in the protocol plugin or directly from
+     *            the corresponding network node.
+     * @return The list of NodeTableStatistics objects containing the statistics
+     *         present in hardware for all the network node tables
      */
-    public List<NodeTableStatistics> readAllNodeTable(String containerName,
-            Node node, boolean cached);
+    public List<NodeTableStatistics> readAllNodeTable(String containerName, Node node, boolean cached);
 
     /**
-     * Returns the average transmit rate for the specified node conenctor on
-     * the given container. If the node connector does not belong to the passed
+     * Returns the average transmit rate for the specified node connector on the
+     * given container. If the node connector does not belong to the passed
      * container a zero value is returned
      *
      * @param container
+     *            the container for which the request is originated
      * @param nodeConnector
-     * @return tx rate [bps]
+     *            the target node connector
+     * @return The average tx rate in bps
      */
     public long getTransmitRate(String container, NodeConnector nodeConnector);
 }