Deprecate old MD-SAL APIs for removal
[controller.git] / opendaylight / md-sal / sal-dom-broker / src / main / java / org / opendaylight / controller / md / sal / dom / broker / impl / AbstractDOMRpcRoutingTableEntry.java
index b346c4e09343cf173ded273a106c874db421d68d..54f343ff15a6b310c765ba296064fb1bffbf0287 100644 (file)
@@ -7,7 +7,8 @@
  */
 package org.opendaylight.controller.md.sal.dom.broker.impl;
 
-import com.google.common.base.Preconditions;
+import static java.util.Objects.requireNonNull;
+
 import com.google.common.collect.ImmutableMap;
 import com.google.common.collect.ImmutableMap.Builder;
 import com.google.common.collect.Maps;
@@ -26,14 +27,15 @@ import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
 
+@Deprecated(forRemoval = true)
 abstract class AbstractDOMRpcRoutingTableEntry {
-    private final Map<YangInstanceIdentifier, List<DOMRpcImplementation>> impls;
+    private final Map<YangInstanceIdentifier, List<DOMRpcImplementation>> implementations;
     private final SchemaPath schemaPath;
 
     AbstractDOMRpcRoutingTableEntry(final SchemaPath schemaPath,
-        final Map<YangInstanceIdentifier, List<DOMRpcImplementation>> impls) {
-        this.schemaPath = Preconditions.checkNotNull(schemaPath);
-        this.impls = Preconditions.checkNotNull(impls);
+        final Map<YangInstanceIdentifier, List<DOMRpcImplementation>> implementations) {
+        this.schemaPath = requireNonNull(schemaPath);
+        this.implementations = requireNonNull(implementations);
     }
 
     final SchemaPath getSchemaPath() {
@@ -41,31 +43,32 @@ abstract class AbstractDOMRpcRoutingTableEntry {
     }
 
     final List<DOMRpcImplementation> getImplementations(final YangInstanceIdentifier context) {
-        return impls.get(context);
+        return implementations.get(context);
     }
 
     final Map<YangInstanceIdentifier, List<DOMRpcImplementation>> getImplementations() {
-        return impls;
+        return implementations;
     }
 
     final boolean containsContext(final YangInstanceIdentifier contextReference) {
-        return impls.containsKey(contextReference);
+        return implementations.containsKey(contextReference);
     }
 
-    final Set<YangInstanceIdentifier> registeredIdentifiers(final DOMRpcAvailabilityListener l) {
-        return Maps.filterValues(impls, list -> list.stream().anyMatch(l::acceptsImplementation)).keySet();
+    final Set<YangInstanceIdentifier> registeredIdentifiers(final DOMRpcAvailabilityListener listener) {
+        return Maps.filterValues(implementations, list -> list.stream().anyMatch(listener::acceptsImplementation))
+                .keySet();
     }
 
     /**
+     * Adds an entry to the DOM RPC routing table.
      *
-     * @param implementation
+     * @param implementation RPC implementation
      * @param newRpcs List of new RPCs, must be mutable
-     * @return
      */
     final AbstractDOMRpcRoutingTableEntry add(final DOMRpcImplementation implementation,
             final List<YangInstanceIdentifier> newRpcs) {
         final Builder<YangInstanceIdentifier, List<DOMRpcImplementation>> vb = ImmutableMap.builder();
-        for (final Entry<YangInstanceIdentifier, List<DOMRpcImplementation>> ve : impls.entrySet()) {
+        for (final Entry<YangInstanceIdentifier, List<DOMRpcImplementation>> ve : implementations.entrySet()) {
             if (newRpcs.remove(ve.getKey())) {
                 final List<DOMRpcImplementation> i = new ArrayList<>(ve.getValue().size() + 1);
                 i.addAll(ve.getValue());
@@ -79,7 +82,7 @@ abstract class AbstractDOMRpcRoutingTableEntry {
                 vb.put(ve);
             }
         }
-        for(final YangInstanceIdentifier ii : newRpcs) {
+        for (final YangInstanceIdentifier ii : newRpcs) {
             final List<DOMRpcImplementation> impl = new ArrayList<>(1);
             impl.add(implementation);
             vb.put(ii, impl);
@@ -91,7 +94,7 @@ abstract class AbstractDOMRpcRoutingTableEntry {
     final AbstractDOMRpcRoutingTableEntry remove(final DOMRpcImplementation implementation,
             final List<YangInstanceIdentifier> removed) {
         final Builder<YangInstanceIdentifier, List<DOMRpcImplementation>> vb = ImmutableMap.builder();
-        for (final Entry<YangInstanceIdentifier, List<DOMRpcImplementation>> ve : impls.entrySet()) {
+        for (final Entry<YangInstanceIdentifier, List<DOMRpcImplementation>> ve : implementations.entrySet()) {
             if (removed.remove(ve.getKey())) {
                 final List<DOMRpcImplementation> i = new ArrayList<>(ve.getValue());
                 i.remove(implementation);
@@ -109,6 +112,8 @@ abstract class AbstractDOMRpcRoutingTableEntry {
         return v.isEmpty() ? null : newInstance(v);
     }
 
-    protected abstract CheckedFuture<DOMRpcResult, DOMRpcException> invokeRpc(final NormalizedNode<?, ?> input);
-    protected abstract AbstractDOMRpcRoutingTableEntry newInstance(final Map<YangInstanceIdentifier, List<DOMRpcImplementation>> impls);
+    protected abstract CheckedFuture<DOMRpcResult, DOMRpcException> invokeRpc(NormalizedNode<?, ?> input);
+
+    protected abstract AbstractDOMRpcRoutingTableEntry newInstance(
+            Map<YangInstanceIdentifier, List<DOMRpcImplementation>> impls);
 }