Add default implementation for AsyncWriteTransaction#commit

[controller.git] / opendaylight / md-sal / sal-common-api / src / main / java / org / opendaylight / controller / md / sal / common / api / routing / RouteChange.java

diff --git a/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/routing/RouteChange.java b/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/routing/RouteChange.java
index 5f84ec579d7dd25bdc9580f785aca6d300c35a0a..1575cc57cc8f560e91ce9c56ac343e5b09dcd3d5 100644 (file)
--- a/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/routing/RouteChange.java
+++ b/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/routing/RouteChange.java
@@ -10,8 +10,37 @@ package org.opendaylight.controller.md.sal.common.api.routing;
 import java.util.Map;
 import java.util.Set;
 
-public interface RouteChange<C,P> {
+/**
+ * Event representing change in RPC routing table.
+ *
+ *
+ * @param <C> Type, which is used to represent Routing context.
+ * @param <P> Type of data tree path, which is used to identify route.
+ */
+public interface RouteChange<C, P> {
 
+    /**
+     * Returns a map of removed routes in associated routing contexts.
+     *
+     * <p>
+     * This map represents routes, which were withdrawn from broker local
+     * routing table and broker may need to forward RPC to other broker
+     * in order to process RPC request.
+     *
+     * @return Map of contexts and removed routes
+     */
     Map<C,Set<P>> getRemovals();
-    Map<C,Set<P>> getAnnouncements();
+
+    /**
+     * Returns a map of announced routes in associated routing contexts.
+     *
+     * <p>
+     * This map represents routes, which were announced by broker
+     * and are present in broker's local routing table. This routes
+     * are processed by implementations which are registered
+     * to originating broker.
+     *
+     * @return Map of contexts and announced routes
+     */
+    Map<C, Set<P>> getAnnouncements();
 }