Restore binding RPC shortcut

[controller.git] / opendaylight / md-sal / sal-dom-compat / src / main / java / org / opendaylight / controller / sal / core / compat / AbstractDOMRpcResultFutureAdapter.java

diff --git a/opendaylight/md-sal/sal-dom-compat/src/main/java/org/opendaylight/controller/sal/core/compat/AbstractDOMRpcResultFutureAdapter.java b/opendaylight/md-sal/sal-dom-compat/src/main/java/org/opendaylight/controller/sal/core/compat/AbstractDOMRpcResultFutureAdapter.java
new file mode 100644 (file)
index 0000000..376682a
--- /dev/null
+++ b/opendaylight/md-sal/sal-dom-compat/src/main/java/org/opendaylight/controller/sal/core/compat/AbstractDOMRpcResultFutureAdapter.java
@@ -0,0 +1,122 @@
+/*
+ * Copyright (c) 2018 Inocybe Technologies and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.opendaylight.controller.sal.core.compat;
+
+import com.google.common.util.concurrent.CheckedFuture;
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+import java.util.Optional;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.Executor;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.TimeoutException;
+import org.opendaylight.mdsal.dom.api.DOMRpcException;
+import org.opendaylight.mdsal.dom.api.DOMRpcResult;
+import org.opendaylight.yangtools.util.concurrent.ExceptionMapper;
+
+/**
+ * Base for a DOMRpcResult future adapter.
+ *
+ * @author Thomas Pantelis
+ */
+@SuppressWarnings("checkstyle:ClassTypeParameterName")
+public abstract class AbstractDOMRpcResultFutureAdapter<T extends DOMRpcResult, TE extends DOMRpcException,
+        F extends DOMRpcResult, FE extends DOMRpcException> implements CheckedFuture<T, TE> {
+    private final CheckedFuture<F, FE> delegate;
+    private final ExceptionMapper<TE> exMapper;
+    private volatile Optional<T> result;
+
+    AbstractDOMRpcResultFutureAdapter(CheckedFuture<F, FE> delegate, ExceptionMapper<TE> exMapper) {
+        this.delegate = delegate;
+        this.exMapper = exMapper;
+    }
+
+    protected abstract T transform(F fromResult);
+
+    public CheckedFuture<F, FE> delegate() {
+        return delegate;
+    }
+
+    @Override
+    public void addListener(Runnable listener, Executor executor) {
+        delegate.addListener(listener, executor);
+    }
+
+    @Override
+    public boolean cancel(boolean mayInterruptIfRunning) {
+        return delegate.cancel(mayInterruptIfRunning);
+    }
+
+    @Override
+    public boolean isCancelled() {
+        return delegate.isCancelled();
+    }
+
+    @Override
+    public boolean isDone() {
+        return delegate.isDone();
+    }
+
+    @Override
+    public T get() throws InterruptedException, ExecutionException {
+        if (result != null) {
+            return result.orElse(null);
+        }
+
+        try {
+            return transformIfNecessary(delegate.get());
+        } catch (ExecutionException e) {
+            throw new ExecutionException(e.getMessage(), exMapper.apply(e));
+        }
+    }
+
+    @Override
+    public T get(final long timeout, final TimeUnit unit) throws InterruptedException, ExecutionException,
+            TimeoutException {
+        if (result != null) {
+            return result.orElse(null);
+        }
+
+        try {
+            return transformIfNecessary(delegate.get(timeout, unit));
+        } catch (ExecutionException e) {
+            throw new ExecutionException(e.getMessage(), exMapper.apply(e));
+        }
+    }
+
+    @Override
+    @SuppressFBWarnings("BC_UNCONFIRMED_CAST_OF_RETURN_VALUE")
+    public T checkedGet() throws TE {
+        try {
+            return get();
+        } catch (InterruptedException | ExecutionException e) {
+            throw exMapper.apply(e);
+        }
+    }
+
+    @Override
+    @SuppressFBWarnings("BC_UNCONFIRMED_CAST_OF_RETURN_VALUE")
+    public T checkedGet(final long timeout, final TimeUnit unit) throws TimeoutException, TE {
+        try {
+            return get(timeout, unit);
+        } catch (InterruptedException | ExecutionException e) {
+            throw exMapper.apply(e);
+        }
+    }
+
+    private synchronized T transformIfNecessary(F delegateResult) {
+        if (result == null) {
+            if (delegateResult == null) {
+                result = Optional.empty();
+            } else {
+                result = Optional.of(transform(delegateResult));
+            }
+        }
+
+        return result.orElse(null);
+    }
+}