yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/builder/impl/ImmutableOrderedMapNodeBuilder.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 com.google.common.base.Optional;
  11 import com.google.common.collect.Iterables;
  12 import java.util.Collection;
  13 import java.util.LinkedHashMap;
  14 import java.util.Map;
  15 import org.opendaylight.yangtools.concepts.Immutable;
  16 import org.opendaylight.yangtools.util.UnmodifiableCollection;
  17 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  18 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  19 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  20 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  21 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  22 import org.opendaylight.yangtools.yang.data.api.schema.OrderedMapNode;
  23 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
  24 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeContainerBuilder;
  25 import org.opendaylight.yangtools.yang.data.impl.schema.nodes.AbstractImmutableNormalizedNode;
  26
  27 public class ImmutableOrderedMapNodeBuilder implements CollectionNodeBuilder<MapEntryNode, OrderedMapNode> {
  28     private static final int DEFAULT_CAPACITY = 4;
  29
  30     private Map<NodeIdentifierWithPredicates, MapEntryNode> value;
  31     private NodeIdentifier nodeIdentifier;
  32     private boolean dirty;
  33
  34     protected ImmutableOrderedMapNodeBuilder() {
  35         this.value = new LinkedHashMap<>(DEFAULT_CAPACITY);
  36         this.dirty = false;
  37     }
  38
  39     protected ImmutableOrderedMapNodeBuilder(final int sizeHint) {
  40         if (sizeHint >= 0) {
  41             this.value = new LinkedHashMap<>(sizeHint + sizeHint / 3);
  42         } else {
  43             this.value = new LinkedHashMap<>(DEFAULT_CAPACITY);
  44         }
  45         this.dirty = false;
  46     }
  47
  48     protected ImmutableOrderedMapNodeBuilder(final ImmutableOrderedMapNode node) {
  49         this.nodeIdentifier = node.getIdentifier();
  50         this.value = node.children;
  51         this.dirty = true;
  52     }
  53
  54     public static CollectionNodeBuilder<MapEntryNode, OrderedMapNode> create() {
  55         return new ImmutableOrderedMapNodeBuilder();
  56     }
  57
  58     public static CollectionNodeBuilder<MapEntryNode, OrderedMapNode> create(final int sizeHint) {
  59         return new ImmutableOrderedMapNodeBuilder(sizeHint);
  60     }
  61
  62     public static CollectionNodeBuilder<MapEntryNode, OrderedMapNode> create(final MapNode node) {
  63         if (!(node instanceof ImmutableOrderedMapNode)) {
  64             throw new UnsupportedOperationException(String.format("Cannot initialize from class %s", node.getClass()));
  65         }
  66
  67         return new ImmutableOrderedMapNodeBuilder((ImmutableOrderedMapNode) node);
  68     }
  69
  70     private void checkDirty() {
  71         if (dirty) {
  72             value = new LinkedHashMap<>(value);
  73             dirty = false;
  74         }
  75     }
  76
  77     @Override
  78     public CollectionNodeBuilder<MapEntryNode, OrderedMapNode> withChild(final MapEntryNode child) {
  79         checkDirty();
  80         this.value.put(child.getIdentifier(), child);
  81         return this;
  82     }
  83
  84     @Override
  85     public CollectionNodeBuilder<MapEntryNode, OrderedMapNode> withoutChild(final PathArgument key) {
  86         checkDirty();
  87         this.value.remove(key);
  88         return this;
  89     }
  90
  91     @Override
  92     public CollectionNodeBuilder<MapEntryNode, OrderedMapNode> withValue(final Collection<MapEntryNode> value) {
  93         // TODO replace or putAll ?
  94         for (final MapEntryNode mapEntryNode : value) {
  95             withChild(mapEntryNode);
  96         }
  97
  98         return this;
  99     }
 100
 101     @Override
 102     public CollectionNodeBuilder<MapEntryNode, OrderedMapNode> withNodeIdentifier(final NodeIdentifier nodeIdentifier) {
 103         this.nodeIdentifier = nodeIdentifier;
 104         return this;
 105     }
 106
 107     @Override
 108     public OrderedMapNode build() {
 109         dirty = true;
 110         return new ImmutableOrderedMapNode(nodeIdentifier, value);
 111     }
 112
 113     @Override
 114     public CollectionNodeBuilder<MapEntryNode, OrderedMapNode> addChild(
 115             final MapEntryNode child) {
 116         return withChild(child);
 117     }
 118
 119
 120     @Override
 121     public NormalizedNodeContainerBuilder<NodeIdentifier, PathArgument, MapEntryNode, OrderedMapNode> removeChild(
 122             final PathArgument key) {
 123         return withoutChild(key);
 124     }
 125
 126     protected static final class ImmutableOrderedMapNode
 127             extends AbstractImmutableNormalizedNode<NodeIdentifier, Collection<MapEntryNode>>
 128             implements Immutable, OrderedMapNode {
 129
 130         private final Map<NodeIdentifierWithPredicates, MapEntryNode> children;
 131
 132         ImmutableOrderedMapNode(final NodeIdentifier nodeIdentifier,
 133                          final Map<NodeIdentifierWithPredicates, MapEntryNode> children) {
 134             super(nodeIdentifier);
 135             this.children = children;
 136         }
 137
 138         @Override
 139         public Optional<MapEntryNode> getChild(final NodeIdentifierWithPredicates child) {
 140             return Optional.fromNullable(children.get(child));
 141         }
 142
 143         @Override
 144         public MapEntryNode getChild(final int position) {
 145             return Iterables.get(children.values(), position);
 146         }
 147
 148         @Override
 149         protected int valueHashCode() {
 150             return children.hashCode();
 151         }
 152
 153         @Override
 154         protected boolean valueEquals(final AbstractImmutableNormalizedNode<?, ?> other) {
 155             return children.equals(((ImmutableOrderedMapNode) other).children);
 156         }
 157
 158         @Override
 159         public int getSize() {
 160             return children.size();
 161         }
 162
 163         @Override
 164         public Collection<MapEntryNode> getValue() {
 165             return UnmodifiableCollection.create(children.values());
 166         }
 167     }
 168 }