2 * Copyright (c) 2020 PANTHEON.tech, s.r.o. 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.parser.rfc7950.stmt;
10 import static com.google.common.base.Verify.verify;
11 import static java.util.Objects.requireNonNull;
13 import com.google.common.annotations.Beta;
14 import com.google.common.collect.ImmutableList;
15 import com.google.common.collect.ImmutableMap;
16 import java.util.HashMap;
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;
22 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
23 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
24 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
25 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
26 import org.opendaylight.yangtools.yang.model.api.meta.IdentifierNamespace;
27 import org.opendaylight.yangtools.yang.model.api.meta.StatementSource;
28 import org.opendaylight.yangtools.yang.model.api.stmt.DataTreeAwareEffectiveStatement;
29 import org.opendaylight.yangtools.yang.model.api.stmt.DataTreeEffectiveStatement;
30 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeAwareEffectiveStatement;
31 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeEffectiveStatement;
32 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStatementMixins.DataNodeContainerMixin;
35 * Base stateless superclass for statements which (logically) always have an associated {@link DeclaredStatement}. This
36 * is notably not true for all {@code case} statements, some of which may actually be implied.
39 * Note implementations are not strictly required to make the declared statement available, they are free to throw
40 * {@link UnsupportedOperationException} from {@link #getDeclared()}, rendering any services relying on declared
41 * statement to be not available.
43 * @param <A> Argument type ({@link Void} if statement does not have argument.)
44 * @param <D> Class representing declared version of this statement.
47 public abstract class AbstractDeclaredEffectiveStatement<A, D extends DeclaredStatement<A>>
48 extends AbstractEffectiveStatement<A, D> {
50 public final StatementSource getStatementSource() {
51 return StatementSource.DECLARATION;
55 public abstract @NonNull D getDeclared();
58 * Base stateless superclass form {@link SchemaTreeAwareEffectiveStatement}s. It maintains the contents of schema
59 * tree namespace based of effective substatements.
61 * @param <A> Argument type ({@link Void} if statement does not have argument.)
62 * @param <D> Class representing declared version of this statement.
63 * @param <E> Class representing effective version of this statement.
65 public abstract static class WithSchemaTree<A, D extends DeclaredStatement<A>,
66 E extends SchemaTreeAwareEffectiveStatement<A, D>> extends AbstractDeclaredEffectiveStatement<A, D> {
68 @SuppressWarnings("unchecked")
69 protected <K, V, N extends IdentifierNamespace<K, V>> Optional<? extends Map<K, V>> getNamespaceContents(
70 final Class<N> namespace) {
71 if (SchemaTreeAwareEffectiveStatement.Namespace.class.equals(namespace)) {
72 return Optional.of((Map<K, V>) schemaTreeNamespace());
74 return super.getNamespaceContents(namespace);
78 * Indexing support for {@link DataNodeContainer#dataChildByName(QName)}.
80 protected final @Nullable DataSchemaNode dataSchemaNode(final QName name) {
81 // Only DataNodeContainer subclasses should be calling this method
82 verify(this instanceof DataNodeContainer);
83 final SchemaTreeEffectiveStatement<?> child = schemaTreeNamespace().get(requireNonNull(name));
84 return child instanceof DataSchemaNode ? (DataSchemaNode) child : null;
87 protected abstract Map<QName, SchemaTreeEffectiveStatement<?>> schemaTreeNamespace();
91 * Base stateless superclass form {@link DataTreeAwareEffectiveStatement}s. It maintains the contents of data tree
92 * namespace based of effective substatements.
94 * @param <A> Argument type ({@link Void} if statement does not have argument.)
95 * @param <D> Class representing declared version of this statement.
96 * @param <E> Class representing effective version of this statement.
98 public abstract static class WithDataTree<A, D extends DeclaredStatement<A>,
99 E extends DataTreeAwareEffectiveStatement<A, D>> extends WithSchemaTree<A, D, E> {
101 @SuppressWarnings("unchecked")
102 protected <K, V, N extends IdentifierNamespace<K, V>> Optional<? extends Map<K, V>> getNamespaceContents(
103 final Class<N> namespace) {
104 if (DataTreeAwareEffectiveStatement.Namespace.class.equals(namespace)) {
105 return Optional.of((Map<K, V>) dataTreeNamespace());
107 return super.getNamespaceContents(namespace);
110 protected abstract Map<QName, DataTreeEffectiveStatement<?>> dataTreeNamespace();
114 * A stateful version of {@link AbstractDeclaredEffectiveStatement}, which holds (and requires) a declared
117 * @param <A> Argument type ({@link Void} if statement does not have argument.)
118 * @param <D> Class representing declared version of this statement.
120 public abstract static class Default<A, D extends DeclaredStatement<A>>
121 extends AbstractDeclaredEffectiveStatement<A, D> {
122 private final @NonNull D declared;
124 protected Default(final D declared) {
125 this.declared = requireNonNull(declared);
128 protected Default(final Default<A, D> original) {
129 this.declared = original.declared;
133 public final D getDeclared() {
139 * Utility class for implementing DataNodeContainer-type statements.
141 public abstract static class DefaultDataNodeContainer<A, D extends DeclaredStatement<A>> extends Default<A, D>
142 implements DataNodeContainerMixin<A, D> {
143 private final @NonNull ImmutableMap<QName, DataSchemaNode> dataChildren;
144 private final @NonNull Object substatements;
146 protected DefaultDataNodeContainer(final D declared,
147 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
149 this.substatements = maskList(substatements);
151 // Note: we do not leak this map, so iteration order does not matter
152 final Map<QName, DataSchemaNode> tmp = new HashMap<>();
154 for (EffectiveStatement<?, ?> stmt : effectiveSubstatements()) {
155 if (stmt instanceof DataSchemaNode) {
156 final DataSchemaNode node = (DataSchemaNode) stmt;
157 final QName id = node.getQName();
158 final DataSchemaNode prev = tmp.put(id, node);
160 throw new SubstatementIndexingException(
161 "Cannot add child with name " + id + ", a conflicting child already exists");
166 dataChildren = ImmutableMap.copyOf(tmp);
170 public final ImmutableList<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
171 return unmaskList(substatements);
175 public final DataSchemaNode dataChildByName(final QName name) {
176 return dataChildren.get(requireNonNull(name));
181 * An extra building block on top of {@link Default}, which is wiring {@link #argument()} to the declared statement.
182 * This is mostly useful for arguments that are not subject to inference transformation -- for example Strings in
183 * {@code description}, etc. This explicitly is not true of statements which underwent namespace binding via
184 * {@code uses} or similar.
186 * @param <A> Argument type ({@link Void} if statement does not have argument.)
187 * @param <D> Class representing declared version of this statement.
189 public abstract static class DefaultArgument<A, D extends DeclaredStatement<A>> extends Default<A, D> {
190 public abstract static class WithSubstatements<A, D extends DeclaredStatement<A>>
191 extends DefaultArgument<A, D> {
192 private final @NonNull Object substatements;
194 protected WithSubstatements(final D declared,
195 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
197 this.substatements = maskList(substatements);
200 protected WithSubstatements(final WithSubstatements<A, D> original) {
202 this.substatements = original.substatements;
206 public final ImmutableList<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
207 return unmaskList(substatements);
211 protected DefaultArgument(final D declared) {
215 protected DefaultArgument(final DefaultArgument<A, D> original) {
220 public final A argument() {
221 return getDeclared().argument();
226 * A building block on top of {@link Default}, which adds an explicit argument value, which is not related to the
227 * context. This is mostly useful when the effective argument value reflects additional statements and similar.
229 * @param <A> Argument type ({@link Void} if statement does not have argument.)
230 * @param <D> Class representing declared version of this statement.
232 public abstract static class DefaultWithArgument<A, D extends DeclaredStatement<A>> extends Default<A, D> {
233 public abstract static class WithSubstatements<A, D extends DeclaredStatement<A>>
234 extends DefaultWithArgument<A, D> {
235 private final @NonNull Object substatements;
237 protected WithSubstatements(final D declared, final A argument,
238 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
239 super(declared, argument);
240 this.substatements = maskList(substatements);
244 public final ImmutableList<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
245 return unmaskList(substatements);
249 private final A argument;
251 protected DefaultWithArgument(final D declared, final A argument) {
253 this.argument = argument;
257 public final A argument() {
263 * Stateful version of {@link WithSchemaTree}. Schema tree namespace is eagerly instantiated (and checked).
265 * @param <A> Argument type ({@link Void} if statement does not have argument.)
266 * @param <D> Class representing declared version of this statement.
267 * @param <E> Class representing effective version of this statement.
269 public abstract static class DefaultWithSchemaTree<A, D extends DeclaredStatement<A>,
270 E extends SchemaTreeAwareEffectiveStatement<A, D>> extends WithSchemaTree<A, D, E> {
271 public abstract static class WithSubstatements<A, D extends DeclaredStatement<A>,
272 E extends SchemaTreeAwareEffectiveStatement<A, D>> extends DefaultWithSchemaTree<A, D, E> {
273 private final @NonNull Object substatements;
275 protected WithSubstatements(final D declared,
276 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
277 super(declared, substatements);
278 this.substatements = maskList(substatements);
281 protected WithSubstatements(final WithSubstatements<A, D, E> original) {
283 this.substatements = original.substatements;
287 public final ImmutableList<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
288 return unmaskList(substatements);
292 private final @NonNull ImmutableMap<QName, SchemaTreeEffectiveStatement<?>> schemaTree;
293 private final @NonNull D declared;
295 protected DefaultWithSchemaTree(final D declared,
296 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
297 this.declared = requireNonNull(declared);
298 this.schemaTree = ImmutableMap.copyOf(createSchemaTreeNamespace(substatements));
301 protected DefaultWithSchemaTree(final DefaultWithSchemaTree<A, D, E> original) {
302 this.declared = original.declared;
303 this.schemaTree = original.schemaTree;
307 public final D getDeclared() {
312 protected final Map<QName, SchemaTreeEffectiveStatement<?>> schemaTreeNamespace() {
318 * Stateful version of {@link WithDataTree}. Schema tree and data tree namespaces are eagerly instantiated
321 * @param <A> Argument type ({@link Void} if statement does not have argument.)
322 * @param <D> Class representing declared version of this statement.
323 * @param <E> Class representing effective version of this statement.
325 public abstract static class DefaultWithDataTree<A, D extends DeclaredStatement<A>,
326 E extends DataTreeAwareEffectiveStatement<A, D>> extends WithDataTree<A, D, E> {
327 public abstract static class WithSubstatements<A, D extends DeclaredStatement<A>,
328 E extends DataTreeAwareEffectiveStatement<A, D>> extends DefaultWithDataTree<A, D, E> {
329 private final @NonNull Object substatements;
331 protected WithSubstatements(final D declared,
332 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
333 super(declared, substatements);
334 this.substatements = maskList(substatements);
337 protected WithSubstatements(final WithSubstatements<A, D, E> original) {
339 this.substatements = original.substatements;
343 public final ImmutableList<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
344 return unmaskList(substatements);
348 private final @NonNull ImmutableMap<QName, SchemaTreeEffectiveStatement<?>> schemaTree;
349 private final @NonNull ImmutableMap<QName, DataTreeEffectiveStatement<?>> dataTree;
350 private final @NonNull D declared;
352 protected DefaultWithDataTree(final D declared,
353 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
354 this.declared = requireNonNull(declared);
355 final Map<QName, SchemaTreeEffectiveStatement<?>> schema = createSchemaTreeNamespace(substatements);
356 this.schemaTree = ImmutableMap.copyOf(schema);
357 this.dataTree = createDataTreeNamespace(schema.values(), schemaTree);
360 protected DefaultWithDataTree(final DefaultWithDataTree<A, D, E> original) {
361 this.declared = original.declared;
362 this.schemaTree = original.schemaTree;
363 this.dataTree = original.dataTree;
367 public final D getDeclared() {
372 protected final Map<QName, SchemaTreeEffectiveStatement<?>> schemaTreeNamespace() {
377 protected final Map<QName, DataTreeEffectiveStatement<?>> dataTreeNamespace() {