Deprecate all MD-SAL APIs
[controller.git] / opendaylight / md-sal / sal-binding-broker / src / main / java / org / opendaylight / controller / md / sal / binding / impl / LazyDataTreeModification.java
1 /*
2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
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.controller.md.sal.binding.impl;
9
10 import java.util.ArrayList;
11 import java.util.Collection;
12 import java.util.List;
13 import java.util.Map.Entry;
14 import org.opendaylight.controller.md.sal.binding.api.DataObjectModification;
15 import org.opendaylight.controller.md.sal.binding.api.DataTreeIdentifier;
16 import org.opendaylight.controller.md.sal.binding.api.DataTreeModification;
17 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
18 import org.opendaylight.mdsal.binding.dom.codec.api.BindingDataObjectCodecTreeNode;
19 import org.opendaylight.yangtools.yang.binding.DataObject;
20 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
21 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
22
23 /**
24  * Lazily translated {@link DataTreeModification} based on {@link DataTreeCandidate}.
25  *
26  * {@link DataTreeModification} represents Data tree change event,
27  * but whole tree is not translated or resolved eagerly, but only child nodes
28  * which are directly accessed by user of data object modification.
29  *
30  */
31 @Deprecated
32 class LazyDataTreeModification<T extends DataObject> implements DataTreeModification<T> {
33
34     private final DataTreeIdentifier<T> path;
35     private final DataObjectModification<T> rootNode;
36
37     LazyDataTreeModification(final LogicalDatastoreType datastoreType, final InstanceIdentifier<T> path,
38             final BindingDataObjectCodecTreeNode<T> codec, final DataTreeCandidate domChange) {
39         this.path = new DataTreeIdentifier<>(datastoreType, path);
40         this.rootNode = LazyDataObjectModification.create(codec, domChange.getRootNode());
41     }
42
43     @Override
44     public DataObjectModification<T> getRootNode() {
45         return rootNode;
46     }
47
48     @Override
49     public DataTreeIdentifier<T> getRootPath() {
50         return path;
51     }
52
53     @SuppressWarnings({"unchecked", "rawtypes"})
54     static <T extends DataObject> DataTreeModification<T> create(final BindingToNormalizedNodeCodec codec,
55             final DataTreeCandidate domChange, final LogicalDatastoreType datastoreType) {
56         final Entry<InstanceIdentifier<?>, BindingDataObjectCodecTreeNode<?>> codecCtx =
57                 codec.getSubtreeCodec(domChange.getRootPath());
58         return new LazyDataTreeModification(datastoreType, codecCtx.getKey(), codecCtx.getValue(), domChange);
59     }
60
61     static <T extends DataObject> Collection<DataTreeModification<T>> from(final BindingToNormalizedNodeCodec codec,
62             final Collection<DataTreeCandidate> domChanges, final LogicalDatastoreType datastoreType) {
63         final List<DataTreeModification<T>> result = new ArrayList<>(domChanges.size());
64         for (final DataTreeCandidate domChange : domChanges) {
65             result.add(LazyDataTreeModification.<T>create(codec, domChange, datastoreType));
66         }
67         return result;
68     }
69
70     @Override
71     public String toString() {
72         return getClass().getSimpleName() + "{path = " + path + ", rootNode = " + rootNode + "}";
73     }
74 }