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.getValue(), 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<? extends PathArgument, ?>> iterable,
  68             final Map<QName, PathArgument> out) {
  69         for (final DataContainerChild<? extends PathArgument, ?> childId : iterable) {
  70             final PathArgument identifier = childId.getIdentifier();
  71
  72             // Augmentation nodes cannot be keys, and do not have to be present in childrenQNamesToPaths map
  73             if (isAugment(identifier)) {
  74                 continue;
  75             }
  76
  77             out.put(childId.getNodeType(), identifier);
  78         }
  79     }
  80
  81
  82     @Override
  83     public DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> withValue(
  84             final Collection<DataContainerChild<? extends PathArgument, ?>> withValue) {
  85         fillQnames(withValue, childrenQNamesToPaths);
  86         return super.withValue(withValue);
  87     }
  88
  89     private static boolean isAugment(final PathArgument identifier) {
  90         return identifier instanceof AugmentationIdentifier;
  91     }
  92
  93     @Override
  94     public DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> withChild(
  95             final DataContainerChild<?, ?> child) {
  96         // Augmentation nodes cannot be keys, and do not have to be present in childrenQNamesToPaths map
  97         if (!isAugment(child.getIdentifier())) {
  98             childrenQNamesToPaths.put(child.getNodeType(), child.getIdentifier());
  99         }
 100
 101         return super.withChild(child);
 102     }
 103
 104     @Override
 105     public MapEntryNode build() {
 106         for (final Entry<QName, Object> key : getNodeIdentifier().entrySet()) {
 107             final DataContainerChild<?, ?> childNode = getChild(childrenQNamesToPaths.get(key.getKey()));
 108
 109             // We have enough information to fill-in missing leaf nodes, so let's do that
 110             if (childNode == null) {
 111                 LeafNode<Object> leaf = ImmutableNodes.leafNode(key.getKey(), key.getValue());
 112                 LOG.debug("Adding leaf {} implied by key {}", leaf, key);
 113                 withChild(leaf);
 114             } else {
 115                 DataValidationException.checkListKey(getNodeIdentifier(), key.getKey(), key.getValue(),
 116                     childNode.getValue());
 117             }
 118         }
 119
 120         return new ImmutableMapEntryNode(getNodeIdentifier(), buildValue());
 121     }
 122
 123     private static final class ImmutableMapEntryNode
 124             extends AbstractImmutableDataContainerNode<NodeIdentifierWithPredicates> implements MapEntryNode {
 125
 126         ImmutableMapEntryNode(final NodeIdentifierWithPredicates nodeIdentifier,
 127                 final Map<PathArgument, DataContainerChild<? extends PathArgument, ?>> children) {
 128             super(children, nodeIdentifier);
 129         }
 130     }
 131 }