Merge branch 'master' of ../controller
[yangtools.git] / yang / yang-data-impl / src / main / java / org / opendaylight / yangtools / yang / data / impl / schema / nodes / AbstractImmutableDataContainerNode.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.nodes;
9
10 import java.util.Collection;
11 import java.util.Map;
12 import java.util.Optional;
13 import org.opendaylight.yangtools.util.ImmutableOffsetMap;
14 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
15 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
16 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerNode;
17
18 public abstract class AbstractImmutableDataContainerNode<K extends PathArgument>
19         extends AbstractImmutableNormalizedNode<K, Collection<DataContainerChild<? extends PathArgument, ?>>>
20         implements DataContainerNode<K> {
21     private final Map<PathArgument, Object> children;
22
23     protected AbstractImmutableDataContainerNode(final Map<PathArgument, Object> children, final K nodeIdentifier) {
24         super(nodeIdentifier);
25
26         this.children = ImmutableOffsetMap.unorderedCopyOf(children);
27     }
28
29     @Override
30     public final Optional<DataContainerChild<? extends PathArgument, ?>> getChild(final PathArgument child) {
31         return LazyLeafOperations.findChild(children, child);
32     }
33
34     @Override
35     public final Collection<DataContainerChild<? extends PathArgument, ?>> getValue() {
36         return LazyLeafOperations.getValue(children);
37     }
38
39     @Override
40     protected int valueHashCode() {
41         return children.hashCode();
42     }
43
44     /**
45      * DO NOT USE THIS METHOD.
46      *
47      * <p>
48      * This is an implementation-internal API and no outside users should use it. If you do, you are asking for trouble,
49      * as the returned object is not guaranteed to conform to java.util.Map interface, nor is its contents well-defined.
50      *
51      * @return An unmodifiable view if this node's children.
52      */
53     public final Map<PathArgument, Object> getChildren() {
54         return children;
55     }
56
57     @Override
58     protected boolean valueEquals(final AbstractImmutableNormalizedNode<?, ?> other) {
59         return other instanceof AbstractImmutableDataContainerNode<?> && children.equals(
60                 ((AbstractImmutableDataContainerNode<?>) other).children);
61     }
62 }