binding/mdsal-binding-dom-adapter/src/main/java/org/opendaylight/mdsal/binding/dom/adapter/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.mdsal.binding.dom.adapter;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.base.MoreObjects;
  13 import java.util.ArrayList;
  14 import java.util.List;
  15 import org.eclipse.jdt.annotation.NonNull;
  16 import org.opendaylight.mdsal.binding.api.DataObjectModification;
  17 import org.opendaylight.mdsal.binding.api.DataTreeIdentifier;
  18 import org.opendaylight.mdsal.binding.api.DataTreeModification;
  19 import org.opendaylight.mdsal.binding.dom.codec.api.BindingDataObjectCodecTreeNode;
  20 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  21 import org.opendaylight.mdsal.dom.api.DOMDataTreeCandidate;
  22 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
  23 import org.opendaylight.yangtools.yang.binding.DataObject;
  24 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  25 import org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidate;
  26
  27 /**
  28  * Lazily translated {@link DataTreeModification} based on {@link DataTreeCandidate}.
  29  *
  30  * <p>
  31  * {@link DataTreeModification} represents Data tree change event, but whole tree is not translated or resolved eagerly,
  32  * but only child nodes which are directly accessed by user of data object modification.
  33  */
  34 final class LazyDataTreeModification<T extends DataObject> implements DataTreeModification<T> {
  35     private final @NonNull DataTreeIdentifier<T> path;
  36     private final @NonNull DataObjectModification<T> rootNode;
  37
  38     private LazyDataTreeModification(final DataTreeIdentifier<T> path, final DataObjectModification<T> modification) {
  39         this.path = requireNonNull(path);
  40         this.rootNode = requireNonNull(modification);
  41     }
  42
  43     @SuppressWarnings({"unchecked", "rawtypes"})
  44     static <T extends DataObject> DataTreeModification<T> create(final CurrentAdapterSerializer serializer,
  45             final DataTreeCandidate domChange, final LogicalDatastoreType datastoreType) {
  46         final InstanceIdentifier<?> bindingPath = serializer.coerceInstanceIdentifier(domChange.getRootPath());
  47         final BindingDataObjectCodecTreeNode<?> codec = serializer.getSubtreeCodec(bindingPath);
  48         final DataTreeIdentifier<?> path = DataTreeIdentifier.create(datastoreType, bindingPath);
  49         return new LazyDataTreeModification(path, LazyDataObjectModification.create(codec, domChange.getRootNode()));
  50     }
  51
  52     @SuppressWarnings({"unchecked", "rawtypes"})
  53     static <T extends DataObject> DataTreeModification<T> create(final CurrentAdapterSerializer serializer,
  54             final DOMDataTreeCandidate candidate) {
  55         final DOMDataTreeIdentifier domRootPath = candidate.getRootPath();
  56         final InstanceIdentifier<?> bindingPath = serializer.coerceInstanceIdentifier(domRootPath.getRootIdentifier());
  57         final BindingDataObjectCodecTreeNode<?> codec = serializer.getSubtreeCodec(bindingPath);
  58         return new LazyDataTreeModification(DataTreeIdentifier.create(domRootPath.getDatastoreType(), bindingPath),
  59             LazyDataObjectModification.create(codec, candidate.getRootNode()));
  60     }
  61
  62     static <T extends DataObject> @NonNull List<DataTreeModification<T>> from(final CurrentAdapterSerializer codec,
  63             final List<DataTreeCandidate> domChanges, final LogicalDatastoreType datastoreType) {
  64         final List<DataTreeModification<T>> result = new ArrayList<>(domChanges.size());
  65         for (final DataTreeCandidate domChange : domChanges) {
  66             result.add(LazyDataTreeModification.create(codec, domChange, datastoreType));
  67         }
  68         return result;
  69     }
  70
  71     @Override
  72     public DataObjectModification<T> getRootNode() {
  73         return rootNode;
  74     }
  75
  76     @Override
  77     public DataTreeIdentifier<T> getRootPath() {
  78         return path;
  79     }
  80
  81     @Override
  82     public String toString() {
  83         return MoreObjects.toStringHelper(this).add("path", path).add("rootNode", rootNode).toString();
  84     }
  85 }