2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.yang.model.api;
10 import static com.google.common.base.Preconditions.checkArgument;
11 import static java.util.Objects.requireNonNull;
13 import com.google.common.annotations.Beta;
14 import java.util.Arrays;
15 import java.util.Collection;
16 import java.util.Iterator;
17 import java.util.NoSuchElementException;
18 import java.util.Optional;
19 import org.eclipse.jdt.annotation.NonNull;
20 import org.eclipse.jdt.annotation.Nullable;
21 import org.opendaylight.yangtools.yang.common.QName;
24 * Node which can contains other nodes.
26 public interface DataNodeContainer {
28 * Returns set of all newly defined types within this DataNodeContainer.
30 * @return typedef statements in lexicographical order
32 @NonNull Collection<? extends @NonNull TypeDefinition<?>> getTypeDefinitions();
35 * Returns set of all child nodes defined within this DataNodeContainer. Although the return type is a collection,
36 * each node is guaranteed to be present at most once.
39 * Note that the nodes returned are <strong>NOT</strong> {@code data nodes}, but rather {@link DataSchemaNode}s,
40 * hence {@link ChoiceSchemaNode} and {@link CaseSchemaNode} are present instead of their children. This
41 * is consistent with {@code schema tree}.
43 * @return child nodes in lexicographical order
45 @NonNull Collection<? extends @NonNull DataSchemaNode> getChildNodes();
48 * Returns set of all groupings defined within this DataNodeContainer.
50 * @return grouping statements in lexicographical order
52 @NonNull Collection<? extends @NonNull GroupingDefinition> getGroupings();
55 * Returns the child node corresponding to the specified name.
58 * Note that the nodes searched are <strong>NOT</strong> {@code data nodes}, but rather {@link DataSchemaNode}s,
59 * hence {@link ChoiceSchemaNode} and {@link CaseSchemaNode} are returned instead of their matching children. This
60 * is consistent with {@code schema tree}.
62 * @param name QName of child
63 * @return child node of this DataNodeContainer if child with given name is present, null otherwise
64 * @deprecated Use {@link #findDataChildByName(QName)} instead.
65 * @throws NullPointerException if {@code name} is null
68 default @Nullable DataSchemaNode getDataChildByName(final QName name) {
69 return findDataChildByName(name).orElse(null);
73 * Returns the child node corresponding to the specified name.
76 * Note that the nodes searched are <strong>NOT</strong> {@code data nodes}, but rather {@link DataSchemaNode}s,
77 * hence {@link ChoiceSchemaNode} and {@link CaseSchemaNode} are returned instead of their matching children.
79 * @param name QName of child
80 * @return child node of this DataNodeContainer if child with given name is present, empty otherwise
81 * @throws NullPointerException if {@code name} is null
83 Optional<DataSchemaNode> findDataChildByName(QName name);
86 * Returns the child node corresponding to the specified name.
89 * Note that the nodes searched are <strong>NOT</strong> {@code data nodes}, but rather {@link DataSchemaNode}s,
90 * hence {@link ChoiceSchemaNode} and {@link CaseSchemaNode} are returned instead of their matching children.
92 * @param first QName of first child
93 * @param others QNames of subsequent children
94 * @return child node of this DataNodeContainer if child with given name is present, empty otherwise
95 * @throws NullPointerException if any argument is null
97 default Optional<DataSchemaNode> findDataChildByName(final QName first, final QName... others) {
98 Optional<DataSchemaNode> optCurrent = findDataChildByName(first);
99 for (QName qname : others) {
100 if (optCurrent.isPresent()) {
101 final DataSchemaNode current = optCurrent.get();
102 if (current instanceof DataNodeContainer) {
103 optCurrent = ((DataNodeContainer) current).findDataChildByName(qname);
108 return Optional.empty();
114 * Returns grouping nodes used ny this container.
116 * @return Set of all uses nodes defined within this DataNodeContainer
118 @NonNull Collection<? extends @NonNull UsesNode> getUses();
121 * Returns a {@code data node} identified by a QName. This method is distinct from
122 * {@link #findDataChildByName(QName)} in that it skips over {@link ChoiceSchemaNode}s and {@link CaseSchemaNode}s,
123 * hence mirroring layout of the {@code data tree}, not {@code schema tree}.
125 * @param name QName identifier of the data node
126 * @return Direct or indirect child of this DataNodeContainer which is a {@code data node}, empty otherwise
127 * @throws NullPointerException if {@code name} is null
130 default Optional<DataSchemaNode> findDataTreeChild(final QName name) {
131 // First we try to find a direct child and check if it is a data node (as per RFC7950)
132 final Optional<DataSchemaNode> optDataChild = findDataChildByName(name);
133 if (HelperMethods.isDataNode(optDataChild)) {
137 // There either is no such node present, or there are Choice/CaseSchemaNodes with the same name involved,
138 // hence we have to resort to a full search.
139 for (DataSchemaNode child : getChildNodes()) {
140 if (child instanceof ChoiceSchemaNode) {
141 for (CaseSchemaNode choiceCase : ((ChoiceSchemaNode) child).getCases()) {
142 final Optional<DataSchemaNode> caseChild = choiceCase.findDataTreeChild(name);
143 if (caseChild.isPresent()) {
150 return Optional.empty();
154 * Returns a {@code data node} identified by a series of QNames. This is equivalent to incrementally calling
155 * {@link #findDataTreeChild(QName)}.
157 * @param path Series of QNames towards identifying the requested data node
158 * @return Direct or indirect child of this DataNodeContainer which is a {@code data node}, empty otherwise
159 * @throws IllegalArgumentException if {@code path} is determined to go beyond a not-container-nor-list node.
160 * @throws NoSuchElementException if {@code path} is empty
161 * @throws NullPointerException if {@code path} is null or contains a null
164 default Optional<DataSchemaNode> findDataTreeChild(final QName... path) {
165 return findDataTreeChild(Arrays.asList(path));
169 * Returns a {@code data node} identified by a series of QNames. This is equivalent to incrementally calling
170 * {@link #findDataTreeChild(QName)}.
172 * @param path Series of QNames towards identifying the requested data node
173 * @return Direct or indirect child of this DataNodeContainer which is a {@code data node}, empty otherwise
174 * @throws IllegalArgumentException if {@code path} is determined to go beyond a not-container-nor-list node.
175 * @throws NoSuchElementException if {@code path} is empty
176 * @throws NullPointerException if {@code path} is null or contains a null
179 default Optional<DataSchemaNode> findDataTreeChild(final Iterable<QName> path) {
180 final Iterator<QName> it = path.iterator();
181 DataNodeContainer parent = this;
183 final Optional<DataSchemaNode> optChild = parent.findDataTreeChild(requireNonNull(it.next()));
184 if (optChild.isEmpty() || !it.hasNext()) {
188 final DataSchemaNode child = optChild.get();
189 checkArgument(child instanceof DataNodeContainer, "Path %s extends beyond terminal child %s", path, child);
190 parent = (DataNodeContainer) child;