yang/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.impl.schema.ImmutableNodes;
  23 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
  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         this.childrenQNamesToPaths = new LinkedHashMap<>();
  36     }
  37
  38     protected ImmutableMapEntryNodeBuilder(final int sizeHint) {
  39         super(sizeHint);
  40         this.childrenQNamesToPaths = new LinkedHashMap<>(sizeHint);
  41     }
  42
  43     protected ImmutableMapEntryNodeBuilder(final ImmutableMapEntryNode node) {
  44         super(node);
  45         this.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)) {
  61             throw new UnsupportedOperationException(String.format("Cannot initialize from class %s", node.getClass()));
  62         }
  63
  64         return new ImmutableMapEntryNodeBuilder((ImmutableMapEntryNode)node);
  65     }
  66
  67     private static void fillQnames(final Iterable<DataContainerChild> iterable, final Map<QName, PathArgument> out) {
  68         for (final DataContainerChild childId : iterable) {
  69             final PathArgument identifier = childId.getIdentifier();
  70
  71             // Augmentation nodes cannot be keys, and do not have to be present in childrenQNamesToPaths map
  72             if (isAugment(identifier)) {
  73                 continue;
  74             }
  75
  76             out.put(childId.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     private static boolean isAugment(final PathArgument identifier) {
  88         return identifier instanceof AugmentationIdentifier;
  89     }
  90
  91     @Override
  92     public DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> withChild(
  93             final DataContainerChild child) {
  94         // Augmentation nodes cannot be keys, and do not have to be present in childrenQNamesToPaths map
  95         if (!isAugment(child.getIdentifier())) {
  96             childrenQNamesToPaths.put(child.getNodeType(), child.getIdentifier());
  97         }
  98
  99         return super.withChild(child);
 100     }
 101
 102     @Override
 103     public MapEntryNode build() {
 104         for (final Entry<QName, Object> key : getNodeIdentifier().entrySet()) {
 105             final DataContainerChild childNode = getChild(childrenQNamesToPaths.get(key.getKey()));
 106
 107             // We have enough information to fill-in missing leaf nodes, so let's do that
 108             if (childNode == null) {
 109                 LeafNode<Object> leaf = ImmutableNodes.leafNode(key.getKey(), key.getValue());
 110                 LOG.debug("Adding leaf {} implied by key {}", leaf, key);
 111                 withChild(leaf);
 112             } else {
 113                 DataValidationException.checkListKey(getNodeIdentifier(), key.getKey(), key.getValue(),
 114                     childNode.body());
 115             }
 116         }
 117
 118         return new ImmutableMapEntryNode(getNodeIdentifier(), buildValue());
 119     }
 120
 121     private static final class ImmutableMapEntryNode
 122             extends AbstractImmutableDataContainerNode<NodeIdentifierWithPredicates, MapEntryNode>
 123             implements MapEntryNode {
 124
 125         ImmutableMapEntryNode(final NodeIdentifierWithPredicates nodeIdentifier,
 126                 final Map<PathArgument, Object> children) {
 127             super(children, nodeIdentifier);
 128         }
 129
 130         @Override
 131         protected Class<MapEntryNode> implementedType() {
 132             return MapEntryNode.class;
 133         }
 134     }
 135 }