Update comments for JavaDoc 73/273/1
authorChi-Vien Ly <chivly@cisco.com>
Wed, 1 May 2013 04:43:15 +0000 (21:43 -0700)
committerChi-Vien Ly <chivly@cisco.com>
Wed, 1 May 2013 04:43:15 +0000 (21:43 -0700)
Added comments for the followings interfaces: IForwardingStaticRouting, IRouting.
Removed the method saveConfig() from IForwardingStaticRouting since it is not a public method and is only use privately.

Change-Id: I15e15916287fe05a02e31536e064fb78c827c26a
Signed-off-by: Chi-Vien Ly <chivly@cisco.com>
opendaylight/forwarding/staticrouting/src/main/java/org/opendaylight/controller/forwarding/staticrouting/IForwardingStaticRouting.java
opendaylight/forwarding/staticrouting/src/main/java/org/opendaylight/controller/forwarding/staticrouting/internal/StaticRoutingImplementation.java
opendaylight/sal/api/src/main/java/org/opendaylight/controller/sal/routing/IRouting.java

index 9b9c0b0..5fabb26 100644 (file)
@@ -18,6 +18,11 @@ import java.util.concurrent.ConcurrentMap;
  */
 import org.opendaylight.controller.sal.utils.Status;
 
  */
 import org.opendaylight.controller.sal.utils.Status;
 
+/**
+ * 
+ * This Interface provides APIs to manage and query the static routes
+ *
+ */
 public interface IForwardingStaticRouting {
 
     /**
 public interface IForwardingStaticRouting {
 
     /**
@@ -48,11 +53,4 @@ public interface IForwardingStaticRouting {
      * If the operation is successful, the return string will be "SUCCESS"
      */
     public Status removeStaticRoute(String name);
      * If the operation is successful, the return string will be "SUCCESS"
      */
     public Status removeStaticRoute(String name);
-
-    /**
-     * Saves the config
-     * @return a text string indicating the result of the operation.
-     * If the operation is successful, the return string will be "Success"
-     */
-    Status saveConfig();
 }
 }
index ad6ea6b..1ac923c 100644 (file)
@@ -131,8 +131,8 @@ public class StaticRoutingImplementation implements IfNewHostNotify,
         }
     }
 
         }
     }
 
-    @Override
-    public Status saveConfig() {
+    
+    private Status saveConfig() {
         // Publish the save config event to the cluster nodes
         configSaveEvent.put(new Date().getTime(), SAVE);
         return saveConfigInternal();
         // Publish the save config event to the cluster nodes
         configSaveEvent.put(new Date().getTime(), SAVE);
         return saveConfigInternal();
index 6d246c6..80950e6 100644 (file)
@@ -15,6 +15,10 @@ import org.opendaylight.controller.sal.core.Edge;
 import org.opendaylight.controller.sal.core.Node;
 import org.opendaylight.controller.sal.core.Path;
 
 import org.opendaylight.controller.sal.core.Node;
 import org.opendaylight.controller.sal.core.Path;
 
+/**
+ * This interface provides APIs to manage and query the routing information
+  *
+ */
 public interface IRouting {
 
     /**
 public interface IRouting {
 
     /**