Integrate PingPongDataBroker into DataBroker contract
[mdsal.git] / binding / mdsal-binding-spi / src / main / java / org / opendaylight / mdsal / binding / spi / ForwardingDataBroker.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 com.google.common.collect.ForwardingObject;
11 import org.eclipse.jdt.annotation.NonNull;
12 import org.opendaylight.mdsal.binding.api.DataBroker;
13 import org.opendaylight.mdsal.binding.api.DataTreeChangeListener;
14 import org.opendaylight.mdsal.binding.api.DataTreeIdentifier;
15 import org.opendaylight.mdsal.binding.api.ReadTransaction;
16 import org.opendaylight.mdsal.binding.api.ReadWriteTransaction;
17 import org.opendaylight.mdsal.binding.api.TransactionChain;
18 import org.opendaylight.mdsal.binding.api.TransactionChainListener;
19 import org.opendaylight.mdsal.binding.api.WriteTransaction;
20 import org.opendaylight.yangtools.concepts.ListenerRegistration;
21 import org.opendaylight.yangtools.yang.binding.DataObject;
22
23 /**
24  * Utility {@link DataBroker} implementation which forwards all interface method invocation to a delegate instance.
25  */
26 public abstract class ForwardingDataBroker extends ForwardingObject implements DataBroker {
27     @Override
28     protected abstract @NonNull DataBroker delegate();
29
30     @Override
31     public ReadTransaction newReadOnlyTransaction() {
32         return delegate().newReadOnlyTransaction();
33     }
34
35     @Override
36     public ReadWriteTransaction newReadWriteTransaction() {
37         return delegate().newReadWriteTransaction();
38     }
39
40     @Override
41     public WriteTransaction newWriteOnlyTransaction() {
42         return delegate().newWriteOnlyTransaction();
43     }
44
45     @Override
46     public <T extends DataObject, L extends DataTreeChangeListener<T>> ListenerRegistration<L>
47             registerDataTreeChangeListener(final DataTreeIdentifier<T> treeId, final L listener) {
48         return delegate().registerDataTreeChangeListener(treeId, listener);
49     }
50
51     @Override
52     public TransactionChain createTransactionChain(final TransactionChainListener listener) {
53         return delegate().createTransactionChain(listener);
54     }
55
56     @Override
57     public TransactionChain createMergingTransactionChain(final TransactionChainListener listener) {
58         return delegate().createMergingTransactionChain(listener);
59     }
60 }