Deprecate ClassToInstance-taking methods

Using a ClassToInstanceMap is not nice, deprecate these methods for
their simple equivalents.

JIRA: MDSAL-854
Change-Id: Ic9574283427c57da8d56c24d34e4d13a02159f77
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>

diff --git a/binding/mdsal-binding-api/src/main/java/org/opendaylight/mdsal/binding/api/RpcProviderService.java b/binding/mdsal-binding-api/src/main/java/org/opendaylight/mdsal/binding/api/RpcProviderService.java
index 6e34376d8938e3e438b6c651ace015ff2cf78d2b..e3a66ba56ce1fd14f7c88234c0360b6f021c7354 100644 (file)
--- a/binding/mdsal-binding-api/src/main/java/org/opendaylight/mdsal/binding/api/RpcProviderService.java
+++ b/binding/mdsal-binding-api/src/main/java/org/opendaylight/mdsal/binding/api/RpcProviderService.java
@@ -91,7 +91,10 @@ public interface RpcProviderService extends BindingService {
      * @param implementations implementation objects
      * @return A {@link Registration} controlling unregistration
      * @throws NullPointerException if {@code implementations} is {@code null}
+     * @deprecated Use {@link #registerRpcImplementations(Collection)} or {@link #registerRpcImplementations(Rpc...)}
+     *             instead.
      */
+    @Deprecated(since = "13.0.1")
     @NonNull Registration registerRpcImplementations(ClassToInstanceMap<Rpc<?, ?>> implementations);
 
     /**
@@ -102,7 +105,9 @@ public interface RpcProviderService extends BindingService {
      * @param implementations implementation objects
      * @return A {@link Registration} controlling unregistration
      * @throws NullPointerException if any argument is {@code null}
+     * @deprecated Use {@link #registerRpcImplementations(Collection, Set)} instead
      */
+    @Deprecated(since = "13.0.1")
     @NonNull Registration registerRpcImplementations(ClassToInstanceMap<Rpc<?, ?>> implementations,
         Set<InstanceIdentifier<?>> paths);
 

diff --git a/binding/mdsal-binding-dom-adapter/src/main/java/org/opendaylight/mdsal/binding/dom/adapter/BindingDOMRpcProviderServiceAdapter.java b/binding/mdsal-binding-dom-adapter/src/main/java/org/opendaylight/mdsal/binding/dom/adapter/BindingDOMRpcProviderServiceAdapter.java
index 6a4c6e1c57c4705682025ad322ec0494b256b335..9f8f67c475ad5fc706fa18ff434136a15905c474 100644 (file)
--- a/binding/mdsal-binding-dom-adapter/src/main/java/org/opendaylight/mdsal/binding/dom/adapter/BindingDOMRpcProviderServiceAdapter.java
+++ b/binding/mdsal-binding-dom-adapter/src/main/java/org/opendaylight/mdsal/binding/dom/adapter/BindingDOMRpcProviderServiceAdapter.java
@@ -9,14 +9,13 @@ package org.opendaylight.mdsal.binding.dom.adapter;
 
 import com.google.common.annotations.VisibleForTesting;
 import com.google.common.collect.ClassToInstanceMap;
-import com.google.common.collect.ImmutableClassToInstanceMap;
 import com.google.common.collect.ImmutableMap;
 import com.google.common.collect.ImmutableSet;
 import java.util.ArrayList;
 import java.util.Collection;
-import java.util.Map;
+import java.util.List;
 import java.util.Set;
-import java.util.function.BiFunction;
+import java.util.function.Function;
 import org.eclipse.jdt.annotation.NonNull;
 import org.opendaylight.mdsal.binding.api.RpcProviderService;
 import org.opendaylight.mdsal.dom.api.DOMRpcIdentifier;
@@ -51,31 +50,43 @@ public class BindingDOMRpcProviderServiceAdapter extends AbstractBindingAdapter<
     }
 
     @Override
-    public Registration registerRpcImplementations(final ClassToInstanceMap<Rpc<?, ?>> implementations) {
+    public Registration registerRpcImplementations(final Collection<Rpc<?, ?>> implementations) {
         return register(currentSerializer(), implementations, GLOBAL);
     }
 
     @Override
-    public Registration registerRpcImplementations(final ClassToInstanceMap<Rpc<?, ?>> implementations,
+    public Registration registerRpcImplementations(final Collection<Rpc<?, ?>> implementations,
             final Set<InstanceIdentifier<?>> paths) {
         final var serializer = currentSerializer();
         return register(serializer, implementations, toYangInstanceIdentifiers(serializer, paths));
     }
 
-    private <T extends Rpc<?, ?>> Registration register(final CurrentAdapterSerializer serializer,
+    @Override
+    @Deprecated(since = "13.0.1")
+    public Registration registerRpcImplementations(final ClassToInstanceMap<Rpc<?, ?>> implementations) {
+        return registerRpcImplementations(implementations.values());
+    }
+
+    @Override
+    @Deprecated(since = "13.0.1")
+    public Registration registerRpcImplementations(final ClassToInstanceMap<Rpc<?, ?>> implementations,
+            final Set<InstanceIdentifier<?>> paths) {
+        return registerRpcImplementations(implementations.values(), paths);
+    }
+
+    private <T extends Rpc<?, ?>> @NonNull Registration register(final CurrentAdapterSerializer serializer,
             final T implementation, final Collection<YangInstanceIdentifier> rpcContextPaths) {
-        @SuppressWarnings("unchecked")
-        final var type = (Class<T>) implementation.implementedInterface();
-        return register(serializer, ImmutableClassToInstanceMap.of(type, implementation), rpcContextPaths);
+        return register(serializer, List.of(implementation), rpcContextPaths);
     }
 
-    private Registration register(final CurrentAdapterSerializer serializer,
-            final ClassToInstanceMap<Rpc<?, ?>> implementations,
+    private @NonNull Registration register(final CurrentAdapterSerializer serializer,
+            final Collection<Rpc<?, ?>> implementations,
             // Note: unique items are implied
             final Collection<YangInstanceIdentifier> rpcContextPaths) {
         final var context = serializer.getRuntimeContext();
 
-        return register(implementations, rpcContextPaths, (type, impl) -> {
+        return register(implementations, rpcContextPaths, impl -> {
+            final var type = impl.implementedInterface();
             final var def = context.getRpcDefinition(type);
             if (def == null) {
                 throw new IllegalArgumentException("Cannot resolve YANG definition of " + type);
@@ -85,12 +96,12 @@ public class BindingDOMRpcProviderServiceAdapter extends AbstractBindingAdapter<
         });
     }
 
-    private <K, V> @NonNull Registration register(final Map<K, V> map, final Collection<YangInstanceIdentifier> paths,
-            final BiFunction<K, V, Impl> implFactory) {
-        final var builder = ImmutableMap.<DOMRpcIdentifier, DOMRpcImplementation>builderWithExpectedSize(map.size());
-        for (var entry : map.entrySet()) {
-            final var impl = implFactory.apply(entry.getKey(), entry.getValue());
-            paths.forEach(path -> builder.put(DOMRpcIdentifier.create(impl.qname, path), impl.impl));
+    private <T> @NonNull Registration register(final Collection<T> impls,
+            final Collection<YangInstanceIdentifier> paths, final Function<T, Impl> implFactory) {
+        final var builder = ImmutableMap.<DOMRpcIdentifier, DOMRpcImplementation>builderWithExpectedSize(impls.size());
+        for (var impl : impls) {
+            final var proxyImpl = implFactory.apply(impl);
+            paths.forEach(path -> builder.put(DOMRpcIdentifier.create(proxyImpl.qname, path), proxyImpl.impl));
         }
         return getDelegate().registerRpcImplementations(builder.build());
     }
@@ -98,7 +109,7 @@ public class BindingDOMRpcProviderServiceAdapter extends AbstractBindingAdapter<
     private static Collection<YangInstanceIdentifier> toYangInstanceIdentifiers(
             final CurrentAdapterSerializer serializer, final Set<InstanceIdentifier<?>> identifiers) {
         final var ret = new ArrayList<YangInstanceIdentifier>(identifiers.size());
-        for (final InstanceIdentifier<?> binding : identifiers) {
+        for (var binding : identifiers) {
             ret.add(serializer.toCachedYangInstanceIdentifier(binding));
         }
         return ret;

diff --git a/binding/mdsal-binding-dom-adapter/src/main/java/org/opendaylight/mdsal/binding/dom/adapter/osgi/OSGiRpcProviderService.java b/binding/mdsal-binding-dom-adapter/src/main/java/org/opendaylight/mdsal/binding/dom/adapter/osgi/OSGiRpcProviderService.java
index d1694dca77ca28cf5f40e49495110c4df5890bea..0266832db80376b5cc1c6131e264e1d8ac6b7362 100644 (file)
--- a/binding/mdsal-binding-dom-adapter/src/main/java/org/opendaylight/mdsal/binding/dom/adapter/osgi/OSGiRpcProviderService.java
+++ b/binding/mdsal-binding-dom-adapter/src/main/java/org/opendaylight/mdsal/binding/dom/adapter/osgi/OSGiRpcProviderService.java
@@ -58,11 +58,13 @@ public final class OSGiRpcProviderService extends AbstractAdaptedService<RpcProv
     }
 
     @Override
+    @Deprecated(since = "13.0.1")
     public Registration registerRpcImplementations(final ClassToInstanceMap<Rpc<?, ?>> implementations) {
         return delegate.registerRpcImplementations(implementations);
     }
 
     @Override
+    @Deprecated(since = "13.0.1")
     public Registration registerRpcImplementations(final ClassToInstanceMap<Rpc<?, ?>> implementations,
             final Set<InstanceIdentifier<?>> paths) {
         return delegate.registerRpcImplementations(implementations, paths);