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