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.LinkedHashMap;
  11 import java.util.List;
  12 import java.util.Map;
  13
  14 import org.opendaylight.yangtools.yang.common.QName;
  15 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  16 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  17 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  18 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  19 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeAttrBuilder;
  20 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.valid.DataValidationException;
  21 import org.opendaylight.yangtools.yang.data.impl.schema.nodes.AbstractImmutableDataContainerAttrNode;
  22
  23 public class ImmutableMapEntryNodeBuilder extends AbstractImmutableDataContainerNodeAttrBuilder<YangInstanceIdentifier.NodeIdentifierWithPredicates, MapEntryNode> {
  24
  25     protected final Map<QName, YangInstanceIdentifier.PathArgument> childrenQNamesToPaths;
  26
  27     protected ImmutableMapEntryNodeBuilder() {
  28         super();
  29         this.childrenQNamesToPaths = new LinkedHashMap<>();
  30     }
  31
  32     protected ImmutableMapEntryNodeBuilder(final int sizeHint) {
  33         super(sizeHint);
  34         this.childrenQNamesToPaths = new LinkedHashMap<>(sizeHint);
  35     }
  36
  37     protected ImmutableMapEntryNodeBuilder(final ImmutableMapEntryNode node) {
  38         super(node);
  39         this.childrenQNamesToPaths = new LinkedHashMap<>();
  40         fillQnames(node.getValue(), childrenQNamesToPaths);
  41     }
  42
  43     public static DataContainerNodeAttrBuilder<YangInstanceIdentifier.NodeIdentifierWithPredicates, MapEntryNode> create() {
  44         return new ImmutableMapEntryNodeBuilder();
  45     }
  46
  47     public static DataContainerNodeAttrBuilder<YangInstanceIdentifier.NodeIdentifierWithPredicates, MapEntryNode> create(final int sizeHint) {
  48         return new ImmutableMapEntryNodeBuilder(sizeHint);
  49     }
  50
  51     public static DataContainerNodeAttrBuilder<YangInstanceIdentifier.NodeIdentifierWithPredicates, MapEntryNode> create(final MapEntryNode node) {
  52         if (!(node instanceof ImmutableMapEntryNode)) {
  53             throw new UnsupportedOperationException(String.format("Cannot initialize from class %s", node.getClass()));
  54         }
  55
  56         return new ImmutableMapEntryNodeBuilder((ImmutableMapEntryNode)node);
  57     }
  58
  59     private static void fillQnames(final Iterable<DataContainerChild<? extends PathArgument, ?>> iterable, final Map<QName, PathArgument> out) {
  60         for (final DataContainerChild<? extends YangInstanceIdentifier.PathArgument, ?> childId : iterable) {
  61             final YangInstanceIdentifier.PathArgument identifier = childId.getIdentifier();
  62
  63             // Augmentation nodes cannot be keys, and do not have to be present in childrenQNamesToPaths map
  64             if(isAugment(identifier)) {
  65                 continue;
  66             }
  67
  68             out.put(childId.getNodeType(), identifier);
  69         }
  70     }
  71
  72
  73     @Override
  74     public DataContainerNodeAttrBuilder<YangInstanceIdentifier.NodeIdentifierWithPredicates, MapEntryNode> withValue(final List<DataContainerChild<? extends YangInstanceIdentifier.PathArgument, ?>> value) {
  75         fillQnames(value, childrenQNamesToPaths);
  76         return super.withValue(value);
  77     }
  78
  79     private static boolean isAugment(final YangInstanceIdentifier.PathArgument identifier) {
  80         return identifier instanceof YangInstanceIdentifier.AugmentationIdentifier;
  81     }
  82
  83     @Override
  84     public DataContainerNodeAttrBuilder<YangInstanceIdentifier.NodeIdentifierWithPredicates, MapEntryNode> withChild(final DataContainerChild<?, ?> child) {
  85         // Augmentation nodes cannot be keys, and do not have to be present in childrenQNamesToPaths map
  86         if(isAugment(child.getIdentifier()) == false) {
  87             childrenQNamesToPaths.put(child.getNodeType(), child.getIdentifier());
  88         }
  89
  90         return super.withChild(child);
  91     }
  92
  93     @Override
  94     public MapEntryNode build() {
  95         checkKeys();
  96         return new ImmutableMapEntryNode(getNodeIdentifier(), buildValue(), getAttributes());
  97     }
  98
  99     private void checkKeys() {
 100         for (final QName keyQName : getNodeIdentifier().getKeyValues().keySet()) {
 101             DataContainerChild<?, ?> childNode = getChild(childrenQNamesToPaths.get(keyQName));
 102             DataValidationException.checkListKey(childNode, getNodeIdentifier().getKeyValues(), keyQName, getNodeIdentifier());
 103         }
 104     }
 105
 106     private static final class ImmutableMapEntryNode extends AbstractImmutableDataContainerAttrNode<YangInstanceIdentifier.NodeIdentifierWithPredicates> implements MapEntryNode {
 107
 108         ImmutableMapEntryNode(final YangInstanceIdentifier.NodeIdentifierWithPredicates nodeIdentifier,
 109                 final Map<YangInstanceIdentifier.PathArgument, DataContainerChild<? extends YangInstanceIdentifier.PathArgument, ?>> children, final Map<QName, String> attributes) {
 110             super(children, nodeIdentifier, attributes);
 111         }
 112     }
 113 }