Merge "Remove public from interface methods. Cleans sonar warnings."
[controller.git] / opendaylight / forwardingrulesmanager / api / src / main / java / org / opendaylight / controller / forwardingrulesmanager / PortGroupProvider.java
index 37cbcd17e6c149e57b0daab5da30085ce4d7f985..dc4f13f497f5e5a0fce7b8035b71cd40512834b1 100644 (file)
@@ -17,51 +17,51 @@ import org.opendaylight.controller.sal.core.Node;
  * application to implement in order to provide Port Grouping Service. Custom
  * Application that implements this interface will have to handle the opaque
  * match criteria passed to it via PortGroupConfig.
- * 
- * 
- * 
+ *
+ *
+ *
  */
 public interface PortGroupProvider {
     /**
      * This method is invoked by the Controller towards the Provider when a new
      * port group is configured.
-     * 
+     *
      * @param config
      *            New PortGroupConfig object created by user Configuration.
      * @return true if successful. false otherwise.
      */
-    public boolean createPortGroupConfig(PortGroupConfig config);
+    boolean createPortGroupConfig(PortGroupConfig config);
 
     /**
      * This method is invoked by the Controller towards the Provider when an
      * existing port group is deleted.
-     * 
+     *
      * @param config
      *            Existing Port Group Configuration deleted by the user.
      * @return true if successful. false otherwise.
      */
-    public boolean deletePortGroupConfig(PortGroupConfig config);
+    boolean deletePortGroupConfig(PortGroupConfig config);
 
     /**
      * Returns the complete mapping database corresponds to a PortGroup
      * Configuration. Its the PortGroupProvider Application's responsibility to
      * manage the Switches & the Set of its Ports that correspond to each of the
      * Configuration and return it to the Controller when requested.
-     * 
+     *
      * @param config
      *            User Configuration
      * @see PortGroupConfig
      * @return Database of Switch-Id to PortGroup mapping that corresponds to
      *         the Port Group User Configuration.
      */
-    public Map<Node, PortGroup> getPortGroupData(PortGroupConfig config);
+    Map<Node, PortGroup> getPortGroupData(PortGroupConfig config);
 
     /**
      * Returns PortGroup data for a given Switch and user Configuration. Its the
      * PortGroupProvider Application's responsibility to manage the Switches &
      * the Set of its Ports that correspond to each of the Configuration and
      * return it to the Controller when requested.
-     * 
+     *
      * @param config
      *            User Configuration
      * @param matrixSwitchId
@@ -70,18 +70,17 @@ public interface PortGroupProvider {
      * @return PortGroup data for a given Openflow switch.
      * @see PortGroup
      */
-    public PortGroup getPortGroupData(PortGroupConfig config,
-            long matrixSwitchId);
+    PortGroup getPortGroupData(PortGroupConfig config, long matrixSwitchId);
 
     /**
      * Registers a Listener for Port Group membership changes based on Custom
      * application algorithm.
-     * 
+     *
      * @param listener
      *            A Controller module that listens to events from the Custom
      *            Port Grouping Application.
      */
-    public void registerPortGroupChange(PortGroupChangeListener listener);
+    void registerPortGroupChange(PortGroupChangeListener listener);
 
     /**
      * Application returns an Usage string for the Match Criteria User
@@ -89,26 +88,26 @@ public interface PortGroupProvider {
      * implement Custom Algorithm for Port Grouping. This method exposes the
      * custom algorithm to the user so that the user can configure the
      * matchString regular expression in PortGroupConfig appropriately.
-     * 
+     *
      * @return Usage string.
      */
-    public String getApplicationDrivenMatchCriteriaUsage();
+    String getApplicationDrivenMatchCriteriaUsage();
 
     /**
      * Returns the name of the Custom Application that implements
      * PortGroupProvider interface.
-     * 
+     *
      * @return Provider Name
      */
-    public String getProviderName();
+    String getProviderName();
 
     /**
      * Controller uses this method to check with the Provider supports the
      * matchCriteria String configured by the User.
-     * 
+     *
      * @param matchCriteria
      * @return true if the Provider supports the matchCriteria String. false
      *         otherwise.
      */
-    public boolean isMatchCriteriaSupported(String matchCriteria);
+    boolean isMatchCriteriaSupported(String matchCriteria);
 }