Expose completion future from WriteOperations
[mdsal.git] / binding / mdsal-binding-spi / src / main / java / org / opendaylight / mdsal / binding / spi / ForwardingWriteTransaction.java
1 /*
2  * Copyright © 2017, 2018 Red Hat, Inc. and others.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8 package org.opendaylight.mdsal.binding.spi;
9
10 import static java.util.Objects.requireNonNull;
11
12 import com.google.common.util.concurrent.FluentFuture;
13 import org.opendaylight.mdsal.binding.api.WriteTransaction;
14 import org.opendaylight.mdsal.common.api.CommitInfo;
15 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
16 import org.opendaylight.yangtools.yang.binding.DataObject;
17 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
18
19 /**
20  * Utility {@link WriteTransaction} implementation which forwards all interface method
21  * invocation to a delegate instance.
22  */
23 public class ForwardingWriteTransaction extends ForwardingTransaction implements WriteTransaction {
24     private final WriteTransaction delegate;
25
26     public ForwardingWriteTransaction(final WriteTransaction delegate) {
27         this.delegate = requireNonNull(delegate);
28     }
29
30     @Override
31     protected WriteTransaction delegate() {
32         return delegate;
33     }
34
35     @Override
36     public <T extends DataObject> void put(final LogicalDatastoreType store, final InstanceIdentifier<T> path,
37             final T data) {
38         delegate.put(store, path, data);
39     }
40
41     @Deprecated
42     @Override
43     public <T extends DataObject> void mergeParentStructurePut(final LogicalDatastoreType store,
44             final InstanceIdentifier<T> path, final T data) {
45         delegate.mergeParentStructurePut(store, path, data);
46     }
47
48     @Deprecated
49     @Override
50     public <T extends DataObject> void merge(final LogicalDatastoreType store, final InstanceIdentifier<T> path,
51             final T data) {
52         delegate.merge(store, path, data);
53     }
54
55     @Deprecated
56     @Override
57     public <T extends DataObject> void mergeParentStructureMerge(final LogicalDatastoreType store,
58             final InstanceIdentifier<T> path, final T data) {
59         delegate.mergeParentStructureMerge(store, path, data);
60     }
61
62     @Override
63     public void delete(final LogicalDatastoreType store, final InstanceIdentifier<?> path) {
64         delegate.delete(store, path);
65     }
66
67     @Override
68     public boolean cancel() {
69         return delegate.cancel();
70     }
71
72     @Override
73     public FluentFuture<? extends CommitInfo> commit() {
74         return delegate.commit();
75     }
76
77     @Override
78     public FluentFuture<?> completionFuture() {
79         return delegate.completionFuture();
80     }
81 }