yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/tree/MapModificationStrategy.java

   1 /*
   2  * Copyright (c) 2019 Pantheon Technologies, s.r.o. 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.yangtools.yang.data.impl.schema.tree;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.base.MoreObjects.ToStringHelper;
  13 import java.util.Optional;
  14 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  15 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  16 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  17 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  18 import org.opendaylight.yangtools.yang.data.api.schema.OrderedMapNode;
  19 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeConfiguration;
  20 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataValidationFailedException;
  21 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.TreeNode;
  22 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.Version;
  23 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  24 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapNodeBuilder;
  25 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableOrderedMapNodeBuilder;
  26 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  27
  28 final class MapModificationStrategy extends AbstractNodeContainerModificationStrategy {
  29     private static final NormalizedNodeContainerSupport<NodeIdentifier, OrderedMapNode> ORDERED_SUPPORT =
  30             new NormalizedNodeContainerSupport<>(OrderedMapNode.class, ChildTrackingPolicy.ORDERED,
  31                     ImmutableOrderedMapNodeBuilder::create, ImmutableOrderedMapNodeBuilder::create);
  32     private static final NormalizedNodeContainerSupport<NodeIdentifier, MapNode> UNORDERED_SUPPORT =
  33             new NormalizedNodeContainerSupport<>(MapNode.class, ImmutableMapNodeBuilder::create,
  34                     ImmutableMapNodeBuilder::create);
  35
  36     private final Optional<ModificationApplyOperation> entryStrategy;
  37     private final MapNode emptyNode;
  38
  39     private MapModificationStrategy(final NormalizedNodeContainerSupport<?, ?> support, final ListSchemaNode schema,
  40         final DataTreeConfiguration treeConfig, final MapNode emptyNode) {
  41         super(support, treeConfig);
  42         this.emptyNode = requireNonNull(emptyNode);
  43         entryStrategy = Optional.of(ListEntryModificationStrategy.of(schema, treeConfig));
  44     }
  45
  46     static MapModificationStrategy of(final ListSchemaNode schema, final DataTreeConfiguration treeConfig) {
  47         final NormalizedNodeContainerSupport<?, ?> support;
  48         final MapNode emptyNode;
  49         if (schema.isUserOrdered()) {
  50             support = ORDERED_SUPPORT;
  51             emptyNode = ImmutableNodes.orderedMapNode(schema.getQName());
  52         } else {
  53             support = UNORDERED_SUPPORT;
  54             emptyNode = ImmutableNodes.mapNode(schema.getQName());
  55         }
  56         return new MapModificationStrategy(support, schema, treeConfig, emptyNode);
  57     }
  58
  59     @Override
  60     public Optional<ModificationApplyOperation> getChild(final YangInstanceIdentifier.PathArgument identifier) {
  61         return identifier instanceof NodeIdentifierWithPredicates ? entryStrategy : Optional.empty();
  62     }
  63
  64     @Override
  65     Optional<TreeNode> apply(final ModifiedNode modification, final Optional<TreeNode> storeMeta,
  66             final Version version) {
  67         return AutomaticLifecycleMixin.apply(super::apply, this::applyWrite, emptyNode, modification, storeMeta,
  68             version);
  69     }
  70
  71     @Override
  72     void checkApplicable(final ModificationPath path, final NodeModification modification,
  73             final Optional<TreeNode> current, final Version version) throws DataValidationFailedException {
  74         AutomaticLifecycleMixin.checkApplicable(super::checkApplicable, emptyNode, path, modification, current,
  75             version);
  76     }
  77
  78     @Override
  79     ToStringHelper addToStringAttributes(final ToStringHelper helper) {
  80         return super.addToStringAttributes(helper).add("entry", entryStrategy.get());
  81     }
  82 }