Fix checkstyle issues under rib-spi

[bgpcep.git] / bgp / rib-spi / src / main / java / org / opendaylight / protocol / bgp / rib / spi / RIBSupport.java

diff --git a/bgp/rib-spi/src/main/java/org/opendaylight/protocol/bgp/rib/spi/RIBSupport.java b/bgp/rib-spi/src/main/java/org/opendaylight/protocol/bgp/rib/spi/RIBSupport.java
index 08bcfa8c0bbe6da72e09c57b02fa50f55d1f80e1..83f787113ba45e50c48622438f4b2b3278ac60fd 100644 (file)
--- a/bgp/rib-spi/src/main/java/org/opendaylight/protocol/bgp/rib/spi/RIBSupport.java
+++ b/bgp/rib-spi/src/main/java/org/opendaylight/protocol/bgp/rib/spi/RIBSupport.java
@@ -41,7 +41,8 @@ public interface RIBSupport extends AddPathRibSupport {
      *
      * @return Protocol-specific case in the routes choice, may not be null.
      */
-    @Nonnull ChoiceNode emptyRoutes();
+    @Nonnull
+    ChoiceNode emptyRoutes();
 
     /**
      * Return the localized identifier of the attributes route member, as expanded
@@ -49,41 +50,49 @@ public interface RIBSupport extends AddPathRibSupport {
      *
      * @return The attributes identifier, may not be null.
      */
-    @Nonnull NodeIdentifier routeAttributesIdentifier();
+    @Nonnull
+    NodeIdentifier routeAttributesIdentifier();
 
     /**
      * Return class object of the Routes Case statement.
      *
      * @return Class
      */
-    @Nonnull Class<? extends Routes> routesCaseClass();
+    @Nonnull
+    Class<? extends Routes> routesCaseClass();
 
     /**
      * Return class object of the Routes Container statement.
      *
      * @return Class
      */
-    @Nonnull Class<? extends DataObject> routesContainerClass();
+    @Nonnull
+    Class<? extends DataObject> routesContainerClass();
 
     /**
      * Return class object of the Routes List statement.
      *
      * @return Class
      */
-    @Nonnull Class<? extends Route> routesListClass();
+    @Nonnull
+    Class<? extends Route> routesListClass();
 
-    @Nonnull ImmutableCollection<Class<? extends DataObject>> cacheableAttributeObjects();
-    @Nonnull ImmutableCollection<Class<? extends DataObject>> cacheableNlriObjects();
+    @Nonnull
+    ImmutableCollection<Class<? extends DataObject>> cacheableAttributeObjects();
+
+    @Nonnull
+    ImmutableCollection<Class<? extends DataObject>> cacheableNlriObjects();
 
     /**
      * Given the NLRI as ContainerNode, this method should extract withdrawn routes
      * from the DOM model and delete them from RIBs.
      *
-     * @param tx DOMDataWriteTransaction
+     * @param tx        DOMDataWriteTransaction
      * @param tablePath YangInstanceIdentifier
-     * @param nlri ContainerNode DOM representation of NLRI in Update message
+     * @param nlri      ContainerNode DOM representation of NLRI in Update message
      */
-    void deleteRoutes(@Nonnull DOMDataWriteTransaction tx, @Nonnull YangInstanceIdentifier tablePath, @Nonnull ContainerNode nlri);
+    void deleteRoutes(@Nonnull DOMDataWriteTransaction tx, @Nonnull YangInstanceIdentifier tablePath,
+            @Nonnull ContainerNode nlri);
 
 
     /**
@@ -95,23 +104,25 @@ public interface RIBSupport extends AddPathRibSupport {
      * For default "bgp-rib" RIBs use {@link #deleteRoutes}
      * </p>
      *
-     * @param tx DOMDataWriteTransaction
-     * @param tablePath YangInstanceIdentifier
-     * @param nlri ContainerNode DOM representation of NLRI in Update message
+     * @param tx           DOMDataWriteTransaction
+     * @param tablePath    YangInstanceIdentifier
+     * @param nlri         ContainerNode DOM representation of NLRI in Update message
      * @param routesNodeId NodeIdentifier of "routes" data node
      */
-    void deleteRoutes(@Nonnull DOMDataWriteTransaction tx, @Nonnull YangInstanceIdentifier tablePath, @Nonnull ContainerNode nlri, @Nonnull NodeIdentifier routesNodeId);
+    void deleteRoutes(@Nonnull DOMDataWriteTransaction tx, @Nonnull YangInstanceIdentifier tablePath,
+            @Nonnull ContainerNode nlri, @Nonnull NodeIdentifier routesNodeId);
 
     /**
      * Given the NLRI as ContainerNode, this method should extract advertised routes
      * from the DOM model and put them into RIBs.
      *
-     * @param tx DOMDataWriteTransaction
-     * @param tablePath YangInstanceIdentifier
-     * @param nlri ContainerNode DOM representation of NLRI in Update message
+     * @param tx         DOMDataWriteTransaction
+     * @param tablePath  YangInstanceIdentifier
+     * @param nlri       ContainerNode DOM representation of NLRI in Update message
      * @param attributes ContainerNode
      */
-    void putRoutes(@Nonnull DOMDataWriteTransaction tx, @Nonnull YangInstanceIdentifier tablePath, @Nonnull ContainerNode nlri, @Nonnull ContainerNode attributes);
+    void putRoutes(@Nonnull DOMDataWriteTransaction tx, @Nonnull YangInstanceIdentifier tablePath,
+            @Nonnull ContainerNode nlri, @Nonnull ContainerNode attributes);
 
     /**
      * Given the NLRI as ContainerNode, this method should extract advertised routes
@@ -122,14 +133,14 @@ public interface RIBSupport extends AddPathRibSupport {
      * For default "bgp-rib" RIBs use {@link #putRoutes}
      * </p>
      *
-     * @param tx DOMDataWriteTransaction
-     * @param tablePath YangInstanceIdentifier
-     * @param nlri ContainerNode DOM representation of NLRI in Update message
-     * @param attributes ContainerNode
+     * @param tx           DOMDataWriteTransaction
+     * @param tablePath    YangInstanceIdentifier
+     * @param nlri         ContainerNode DOM representation of NLRI in Update message
+     * @param attributes   ContainerNode
      * @param routesNodeId NodeIdentifier of "routes" data node
      */
-    void putRoutes(@Nonnull DOMDataWriteTransaction tx, @Nonnull YangInstanceIdentifier tablePath, @Nonnull ContainerNode nlri,
-            @Nonnull ContainerNode attributes, @Nonnull NodeIdentifier routesNodeId);
+    void putRoutes(@Nonnull DOMDataWriteTransaction tx, @Nonnull YangInstanceIdentifier tablePath,
+            @Nonnull ContainerNode nlri, @Nonnull ContainerNode attributes, @Nonnull NodeIdentifier routesNodeId);
 
     /**
      * Returns routes that were modified within this RIB support instance.
@@ -137,16 +148,19 @@ public interface RIBSupport extends AddPathRibSupport {
      * @param routes DataTreeCandidateNode
      * @return collection of modified nodes or empty collection if no node was modified
      */
-    @Nonnull Collection<DataTreeCandidateNode> changedRoutes(@Nonnull DataTreeCandidateNode routes);
+    @Nonnull
+    Collection<DataTreeCandidateNode> changedRoutes(@Nonnull DataTreeCandidateNode routes);
 
     /**
      * Constructs an instance identifier path to routeId.
      *
      * @param routesPath YangInstanceIdentifier base path
-     * @param routeId PathArgument leaf path
+     * @param routeId    PathArgument leaf path
      * @return YangInstanceIdentifier with routesPath + specific RIB support routes path + routeId
      */
-    @Nonnull YangInstanceIdentifier routePath(@Nonnull YangInstanceIdentifier routesPath, @Nonnull PathArgument routeId);
+    @Nonnull
+    YangInstanceIdentifier routePath(@Nonnull YangInstanceIdentifier routesPath,
+            @Nonnull PathArgument routeId);
 
     /**
      * Indicate whether this AFI/SAFI combination is a complex route. Simple routes are those which
@@ -161,20 +175,25 @@ public interface RIBSupport extends AddPathRibSupport {
      * binding-aware format. This needs to be done per each AFI/SAFI.
      *
      * @param advertised Collection of advertised routes in DOM format
-     * @param withdrawn Collection of withdrawn routes in DOM format
-     * @param attr Attributes MpReach is part of Attributes so we need to pass
-     *             it as argument, create new AttributesBuilder with existing
-     *             attributes and add MpReach
+     * @param withdrawn  Collection of withdrawn routes in DOM format
+     * @param attr       Attributes MpReach is part of Attributes so we need to pass
+     *                   it as argument, create new AttributesBuilder with existing
+     *                   attributes and add MpReach
      * @return Update message ready to be sent out
      */
-    @Nonnull Update buildUpdate(@Nonnull Collection<MapEntryNode> advertised, @Nonnull Collection<MapEntryNode> withdrawn, @Nonnull Attributes attr);
+    @Nonnull
+    Update buildUpdate(@Nonnull Collection<MapEntryNode> advertised,
+            @Nonnull Collection<MapEntryNode> withdrawn, @Nonnull Attributes attr);
 
-    @Nonnull Class<? extends AddressFamily> getAfi();
+    @Nonnull
+    Class<? extends AddressFamily> getAfi();
 
-    @Nonnull Class<? extends SubsequentAddressFamily> getSafi();
+    @Nonnull
+    Class<? extends SubsequentAddressFamily> getSafi();
 
     interface ApplyRoute {
-        void apply(DOMDataWriteTransaction tx, YangInstanceIdentifier base, NodeIdentifierWithPredicates routeKey, DataContainerNode<?> route,
-            ContainerNode attributes);
+        void apply(@Nonnull DOMDataWriteTransaction tx, @Nonnull YangInstanceIdentifier base,
+                @Nonnull NodeIdentifierWithPredicates routeKey,
+                @Nonnull DataContainerNode<?> route, ContainerNode attributes);
     }
 }