Update WriteOperations/TypedTransaction API design
[mdsal.git] / binding / mdsal-binding-util / src / main / java / org / opendaylight / mdsal / binding / util / WriteTrackingReadWriteTransaction.java
1 /*
2  * Copyright © 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.util;
9
10 import org.opendaylight.mdsal.binding.api.ReadWriteTransaction;
11 import org.opendaylight.mdsal.binding.spi.ForwardingReadWriteTransaction;
12 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
13 import org.opendaylight.yangtools.yang.binding.DataObject;
14 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
15
16 /**
17  * Read-write transaction which keeps track of writes.
18  */
19 final class WriteTrackingReadWriteTransaction extends ForwardingReadWriteTransaction
20         implements WriteTrackingTransaction {
21     // This is volatile to ensure we get the latest value; transactions aren't supposed to be used in multiple threads,
22     // but the cost here is tiny (one read penalty at the end of a transaction) so we play it safe
23     private volatile boolean written;
24
25     WriteTrackingReadWriteTransaction(final ReadWriteTransaction delegate) {
26         super(delegate);
27     }
28
29     @Override
30     public <T extends DataObject> void put(final LogicalDatastoreType store, final InstanceIdentifier<T> path,
31             final T data) {
32         super.put(store, path, data);
33         written = true;
34     }
35
36     @Override
37     @Deprecated
38     public <T extends DataObject> void put(final LogicalDatastoreType store, final InstanceIdentifier<T> path,
39             final T data, final boolean createMissingParents) {
40         super.put(store, path, data, createMissingParents);
41         written = true;
42     }
43
44     @Override
45     public <T extends DataObject> void mergeParentStructurePut(final LogicalDatastoreType store,
46             final InstanceIdentifier<T> path, final T data) {
47         super.mergeParentStructurePut(store, path, data);
48         written = true;
49     }
50
51     @Override
52     public <T extends DataObject> void merge(final LogicalDatastoreType store, final InstanceIdentifier<T> path,
53             final T data) {
54         super.merge(store, path, data);
55         written = true;
56     }
57
58     @Override
59     @Deprecated
60     public <T extends DataObject> void merge(final LogicalDatastoreType store, final InstanceIdentifier<T> path,
61             final T data, final boolean createMissingParents) {
62         super.merge(store, path, data, createMissingParents);
63         written = true;
64     }
65
66     @Override
67     public <T extends DataObject> void mergeParentStructureMerge(final LogicalDatastoreType store,
68             final InstanceIdentifier<T> path, final T data) {
69         super.mergeParentStructureMerge(store, path, data);
70         written = true;
71     }
72
73     @Override
74     public void delete(final LogicalDatastoreType store, final InstanceIdentifier<?> path) {
75         super.delete(store, path);
76         written = true;
77     }
78
79     @Override
80     public boolean isWritten() {
81         return written;
82     }
83 }