yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/builder/impl/AbstractImmutableDataContainerNodeBuilder.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.HashMap;
  11 import java.util.List;
  12 import java.util.Map;
  13
  14 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier;
  15 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier.PathArgument;
  16 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  17 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerNode;
  18 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
  19 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeContainerBuilder;
  20 import org.opendaylight.yangtools.yang.data.impl.schema.nodes.AbstractImmutableDataContainerNode;
  21
  22 abstract class AbstractImmutableDataContainerNodeBuilder<I extends InstanceIdentifier.PathArgument, R extends DataContainerNode<I>>
  23         implements DataContainerNodeBuilder<I, R> {
  24
  25     private Map<InstanceIdentifier.PathArgument, DataContainerChild<? extends InstanceIdentifier.PathArgument, ?>> value;
  26     private I nodeIdentifier;
  27
  28     /*
  29      * Tracks whether the builder is dirty, e.g. whether the value map has been used
  30      * to construct a child. If it has, we detect this condition before any further
  31      * modification and create a new value map with same contents. This way we do not
  32      * force a map copy if the builder is not reused.
  33      */
  34     private boolean dirty;
  35
  36     protected AbstractImmutableDataContainerNodeBuilder() {
  37         this.value = new HashMap<>();
  38         this.dirty = false;
  39     }
  40
  41     protected AbstractImmutableDataContainerNodeBuilder(final AbstractImmutableDataContainerNode<I> node) {
  42         this.nodeIdentifier = node.getIdentifier();
  43         this.value = node.getChildren();
  44         this.dirty = true;
  45     }
  46
  47     protected final I getNodeIdentifier() {
  48         return nodeIdentifier;
  49     }
  50
  51     protected final DataContainerChild<? extends PathArgument, ?> getChild(final PathArgument child) {
  52         return value.get(child);
  53     }
  54
  55     protected final Map<PathArgument, DataContainerChild<? extends PathArgument, ?>> buildValue() {
  56         dirty = true;
  57         return value;
  58     }
  59
  60     private void checkDirty() {
  61         if (dirty) {
  62             value = new HashMap<>(value);
  63             dirty = false;
  64         }
  65     }
  66
  67     @Override
  68     public DataContainerNodeBuilder<I, R> withValue(final List<DataContainerChild<? extends InstanceIdentifier.PathArgument, ?>> value) {
  69         // TODO Replace or putAll ?
  70         for (final DataContainerChild<? extends InstanceIdentifier.PathArgument, ?> dataContainerChild : value) {
  71             withChild(dataContainerChild);
  72         }
  73         return this;
  74     }
  75
  76     @Override
  77     public DataContainerNodeBuilder<I, R> withChild(final DataContainerChild<?, ?> child) {
  78         checkDirty();
  79         this.value.put(child.getIdentifier(), child);
  80         return this;
  81     }
  82
  83     @Override
  84     public DataContainerNodeBuilder<I, R> withoutChild(final PathArgument key) {
  85         checkDirty();
  86         this.value.remove(key);
  87         return this;
  88     }
  89
  90     @Override
  91     public DataContainerNodeBuilder<I, R> withNodeIdentifier(final I nodeIdentifier) {
  92         this.nodeIdentifier = nodeIdentifier;
  93         return this;
  94     }
  95
  96     @Override
  97     public DataContainerNodeBuilder<I, R> addChild(
  98             final DataContainerChild<? extends PathArgument, ?> child) {
  99         return withChild(child);
 100     }
 101
 102     @Override
 103     public NormalizedNodeContainerBuilder<I, PathArgument, DataContainerChild<? extends PathArgument, ?>, R> removeChild(final PathArgument key) {
 104         return withoutChild(key);
 105     }
 106 }