data/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/builder/impl/ImmutableMapEntryNodeBuilder.java

   1 /*
   2  * Copyright (c) 2013 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.yangtools.yang.data.impl.schema.builder.impl;
   9
  10 import java.util.Collection;
  11 import java.util.LinkedHashMap;
  12 import java.util.Map;
  13 import java.util.Map.Entry;
  14 import org.eclipse.jdt.annotation.NonNull;
  15 import org.opendaylight.yangtools.yang.common.QName;
  16 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
  17 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  18 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  19 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  20 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  21 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  22 import org.opendaylight.yangtools.yang.data.api.schema.builder.DataContainerNodeBuilder;
  23 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  24 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.valid.DataValidationException;
  25 import org.opendaylight.yangtools.yang.data.impl.schema.nodes.AbstractImmutableDataContainerNode;
  26 import org.slf4j.Logger;
  27 import org.slf4j.LoggerFactory;
  28
  29 public class ImmutableMapEntryNodeBuilder
  30         extends AbstractImmutableDataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> {
  31     private static final Logger LOG = LoggerFactory.getLogger(ImmutableMapEntryNodeBuilder.class);
  32     protected final Map<QName, PathArgument> childrenQNamesToPaths;
  33
  34     protected ImmutableMapEntryNodeBuilder() {
  35         childrenQNamesToPaths = new LinkedHashMap<>();
  36     }
  37
  38     protected ImmutableMapEntryNodeBuilder(final int sizeHint) {
  39         super(sizeHint);
  40         childrenQNamesToPaths = new LinkedHashMap<>(sizeHint);
  41     }
  42
  43     protected ImmutableMapEntryNodeBuilder(final ImmutableMapEntryNode node) {
  44         super(node);
  45         childrenQNamesToPaths = new LinkedHashMap<>();
  46         fillQNames(node.body(), childrenQNamesToPaths);
  47     }
  48
  49     public static @NonNull DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> create() {
  50         return new ImmutableMapEntryNodeBuilder();
  51     }
  52
  53     public static @NonNull DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> create(
  54             final int sizeHint) {
  55         return new ImmutableMapEntryNodeBuilder(sizeHint);
  56     }
  57
  58     public static @NonNull DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> create(
  59             final MapEntryNode node) {
  60         if (!(node instanceof ImmutableMapEntryNode immutableNode)) {
  61             throw new UnsupportedOperationException("Cannot initialize from class " + node.getClass());
  62         }
  63         return new ImmutableMapEntryNodeBuilder(immutableNode);
  64     }
  65
  66     private static void fillQNames(final Iterable<DataContainerChild> iterable, final Map<QName, PathArgument> out) {
  67         for (final DataContainerChild child : iterable) {
  68             putQName(out, child);
  69         }
  70     }
  71
  72     private static void putQName(final Map<QName, PathArgument> map, final DataContainerChild child) {
  73         // Augmentation nodes cannot be keys, and do not have to be present in childrenQNamesToPaths map
  74         final PathArgument identifier = child.getIdentifier();
  75         if (!(identifier instanceof AugmentationIdentifier)) {
  76             map.put(identifier.getNodeType(), identifier);
  77         }
  78     }
  79
  80     @Override
  81     public DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> withValue(
  82             final Collection<DataContainerChild> withValue) {
  83         fillQNames(withValue, childrenQNamesToPaths);
  84         return super.withValue(withValue);
  85     }
  86
  87     @Override
  88     public DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> withChild(
  89             final DataContainerChild child) {
  90         putQName(childrenQNamesToPaths, child);
  91         return super.withChild(child);
  92     }
  93
  94     @Override
  95     public MapEntryNode build() {
  96         for (final Entry<QName, Object> key : getNodeIdentifier().entrySet()) {
  97             final DataContainerChild childNode = getChild(childrenQNamesToPaths.get(key.getKey()));
  98
  99             // We have enough information to fill-in missing leaf nodes, so let's do that
 100             if (childNode == null) {
 101                 LeafNode<Object> leaf = ImmutableNodes.leafNode(key.getKey(), key.getValue());
 102                 LOG.debug("Adding leaf {} implied by key {}", leaf, key);
 103                 withChild(leaf);
 104             } else {
 105                 DataValidationException.checkListKey(getNodeIdentifier(), key.getKey(), key.getValue(),
 106                     childNode.body());
 107             }
 108         }
 109
 110         return new ImmutableMapEntryNode(getNodeIdentifier(), buildValue());
 111     }
 112
 113     private static final class ImmutableMapEntryNode
 114             extends AbstractImmutableDataContainerNode<NodeIdentifierWithPredicates, MapEntryNode>
 115             implements MapEntryNode {
 116
 117         ImmutableMapEntryNode(final NodeIdentifierWithPredicates nodeIdentifier,
 118                 final Map<PathArgument, Object> children) {
 119             super(children, nodeIdentifier);
 120         }
 121
 122         @Override
 123         protected Class<MapEntryNode> implementedType() {
 124             return MapEntryNode.class;
 125         }
 126     }
 127 }