BUG-2383: document AbstractRIBSupport abstract methods

Add javadoc and rename for consistency.

Change-Id: I153f7f0ecfccd45084b95779a514a23008d30296
Signed-off-by: Robert Varga <rovarga@cisco.com>

diff --git a/bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/AbstractIPRIBSupport.java b/bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/AbstractIPRIBSupport.java
index 3ae3944097b2993a12a7f77b6facc11f1bb94324..cfd14de4fb73a50626d9fd73fee75d8d16a23387 100644 (file)
--- a/bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/AbstractIPRIBSupport.java
+++ b/bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/AbstractIPRIBSupport.java
@@ -10,6 +10,7 @@ package org.opendaylight.protocol.bgp.rib.impl;
 import com.google.common.base.Optional;
 import java.util.Collection;
 import java.util.Collections;
+import javax.annotation.Nonnull;
 import org.opendaylight.controller.config.yang.bgp.rib.spi.AbstractRIBSupport;
 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
@@ -74,7 +75,12 @@ abstract class AbstractIPRIBSupport extends AbstractRIBSupport {
         super(routesContainer);
     }
 
-    protected abstract NodeIdentifier routeIdentifier();
+    /**
+     * Return the NodeIdentifier corresponding to the list containing individual routes.
+     *
+     * @return The NodeIdentifier for individual route list.
+     */
+    @Nonnull protected abstract NodeIdentifier routeIdentifier();
 
     @Override
     public final Collection<Class<? extends DataObject>> cacheableAttributeObjects() {

diff --git a/bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/IPv4RIBSupport.java b/bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/IPv4RIBSupport.java
index 853b42997f7e57454f74d1853a4c67097e019319..42afe6d06507b0e69928d5e4fc81f046a018f46b 100644 (file)
--- a/bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/IPv4RIBSupport.java
+++ b/bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/IPv4RIBSupport.java
@@ -43,7 +43,7 @@ final class IPv4RIBSupport extends AbstractIPRIBSupport {
     }
 
     @Override
-    protected NodeIdentifier destinationIdentifier() {
+    protected NodeIdentifier destinationContainerIdentifier() {
         return destination;
     }
 

diff --git a/bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/IPv6RIBSupport.java b/bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/IPv6RIBSupport.java
index 67be441b52b528e2ea8cc968d880be5d3e7ec438..8e856565434bb41f665efcdb3fb735be3e034b3f 100644 (file)
--- a/bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/IPv6RIBSupport.java
+++ b/bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/IPv6RIBSupport.java
@@ -43,7 +43,7 @@ final class IPv6RIBSupport extends AbstractIPRIBSupport {
     }
 
     @Override
-    protected NodeIdentifier destinationIdentifier() {
+    protected NodeIdentifier destinationContainerIdentifier() {
         return destination;
     }
 

diff --git a/bgp/rib-spi/src/main/java/org/opendaylight/controller/config/yang/bgp/rib/spi/AbstractRIBSupport.java b/bgp/rib-spi/src/main/java/org/opendaylight/controller/config/yang/bgp/rib/spi/AbstractRIBSupport.java
index 245f63336fd51ad71a76d42c2ee6f2da572459c3..ab32962040f15057c6262b07bf5c340e24987ce4 100644 (file)
--- a/bgp/rib-spi/src/main/java/org/opendaylight/controller/config/yang/bgp/rib/spi/AbstractRIBSupport.java
+++ b/bgp/rib-spi/src/main/java/org/opendaylight/controller/config/yang/bgp/rib/spi/AbstractRIBSupport.java
@@ -61,7 +61,14 @@ public abstract class AbstractRIBSupport implements RIBSupport {
         return routesContainerIdentifier;
     }
 
-    protected abstract NodeIdentifier destinationIdentifier();
+    /**
+     * Return the {@link NodeIdentifier} of the AFI/SAFI-specific container under
+     * the NLRI destination.
+     *
+     * @return Container identifier, may not be null.
+     */
+    @Nonnull protected abstract NodeIdentifier destinationContainerIdentifier();
+
     protected abstract void deleteDestinationRoutes(DOMDataWriteTransaction tx, YangInstanceIdentifier tablePath, ContainerNode destination);
     protected abstract void putDestinationRoutes(DOMDataWriteTransaction tx, YangInstanceIdentifier tablePath, ContainerNode destination, ContainerNode attributes);
 
@@ -121,7 +128,7 @@ public abstract class AbstractRIBSupport implements RIBSupport {
     public final void deleteRoutes(final DOMDataWriteTransaction tx, final YangInstanceIdentifier tablePath, final ContainerNode nlri) {
         final Optional<DataContainerChild<? extends PathArgument, ?>> maybeRoutes = nlri.getChild(WITHDRAWN_ROUTES);
         if (maybeRoutes.isPresent()) {
-            final ContainerNode destination = getDestination(maybeRoutes.get(), destinationIdentifier());
+            final ContainerNode destination = getDestination(maybeRoutes.get(), destinationContainerIdentifier());
             if (destination != null) {
                 deleteDestinationRoutes(tx, tablePath, destination);
             }
@@ -134,7 +141,7 @@ public abstract class AbstractRIBSupport implements RIBSupport {
     public final void putRoutes(final DOMDataWriteTransaction tx, final YangInstanceIdentifier tablePath, final ContainerNode nlri, final ContainerNode attributes) {
         final Optional<DataContainerChild<? extends PathArgument, ?>> maybeRoutes = nlri.getChild(ADVERTIZED_ROUTES);
         if (maybeRoutes.isPresent()) {
-            final ContainerNode destination = getDestination(maybeRoutes.get(), destinationIdentifier());
+            final ContainerNode destination = getDestination(maybeRoutes.get(), destinationContainerIdentifier());
             if (destination != null) {
                 putDestinationRoutes(tx, tablePath, destination, attributes);
             }