caabdfff67392dc7de6b3b66d0cf0bdfafab783b
[yangtools.git] / model / yang-model-ri / src / main / java / org / opendaylight / yangtools / yang / model / ri / stmt / impl / eff / AbstractDataNodeContainer.java
1 /*
2  * Copyright (c) 2020 PANTHEON.tech, s.r.o. 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.model.ri.stmt.impl.eff;
9
10 import static java.util.Objects.requireNonNull;
11
12 import com.google.common.annotations.Beta;
13 import com.google.common.collect.ImmutableList;
14 import com.google.common.collect.ImmutableMap;
15 import java.util.HashMap;
16 import java.util.Map;
17 import org.eclipse.jdt.annotation.NonNull;
18 import org.opendaylight.yangtools.yang.common.QName;
19 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
20 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
21 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
22 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
23 import org.opendaylight.yangtools.yang.model.spi.meta.AbstractDeclaredEffectiveStatement.Default;
24 import org.opendaylight.yangtools.yang.model.spi.meta.EffectiveStatementMixins.DataNodeContainerMixin;
25 import org.opendaylight.yangtools.yang.model.spi.meta.SubstatementIndexingException;
26
27 /**
28  * Utility class for implementing {@link DataNodeContainer}-type statements.
29  */
30 @Beta
31 public abstract class AbstractDataNodeContainer<A, D extends DeclaredStatement<A>> extends Default<A, D>
32         implements DataNodeContainerMixin<A, D> {
33     private final @NonNull ImmutableMap<QName, DataSchemaNode> dataChildren;
34     private final @NonNull Object substatements;
35
36     protected AbstractDataNodeContainer(final D declared,
37             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
38         super(declared);
39         this.substatements = maskList(substatements);
40
41         // Note: we do not leak this map, so iteration order does not matter
42         final Map<QName, DataSchemaNode> tmp = new HashMap<>();
43
44         for (EffectiveStatement<?, ?> stmt : effectiveSubstatements()) {
45             if (stmt instanceof DataSchemaNode) {
46                 final DataSchemaNode node = (DataSchemaNode) stmt;
47                 final QName id = node.getQName();
48                 final DataSchemaNode prev = tmp.put(id, node);
49                 if (prev != null) {
50                     throw new SubstatementIndexingException(
51                         "Cannot add child with name " + id + ", a conflicting child already exists");
52                 }
53             }
54         }
55
56         dataChildren = ImmutableMap.copyOf(tmp);
57     }
58
59     @Override
60     public final ImmutableList<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
61         return unmaskList(substatements);
62     }
63
64     @Override
65     public final DataSchemaNode dataChildByName(final QName name) {
66         return dataChildren.get(requireNonNull(name));
67     }
68 }