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);
129 public final D getDeclared() {
135 * Utility class for implementing DataNodeContainer-type statements.
137 public abstract static class DefaultDataNodeContainer<A, D extends DeclaredStatement<A>> extends Default<A, D>
138 implements DataNodeContainerMixin<A, D> {
139 private final @NonNull ImmutableMap<QName, DataSchemaNode> dataChildren;
140 private final @NonNull Object substatements;
142 protected DefaultDataNodeContainer(final D declared,
143 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
145 this.substatements = maskList(substatements);
147 // Note: we do not leak this map, so iteration order does not matter
148 final Map<QName, DataSchemaNode> tmp = new HashMap<>();
150 for (EffectiveStatement<?, ?> stmt : effectiveSubstatements()) {
151 if (stmt instanceof DataSchemaNode) {
152 final DataSchemaNode node = (DataSchemaNode) stmt;
153 final QName id = node.getQName();
154 final DataSchemaNode prev = tmp.put(id, node);
156 throw new SubstatementIndexingException(
157 "Cannot add child with name " + id + ", a conflicting child already exists");
162 dataChildren = ImmutableMap.copyOf(tmp);
166 public final ImmutableList<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
167 return unmaskList(substatements);
171 public final DataSchemaNode dataChildByName(final QName name) {
172 return dataChildren.get(requireNonNull(name));
177 * An extra building block on top of {@link Default}, which is wiring {@link #argument()} to the declared statement.
178 * This is mostly useful for arguments that are not subject to inference transformation -- for example Strings in
179 * {@code description}, etc. This explicitly is not true of statements which underwent namespace binding via
180 * {@code uses} or similar.
182 * @param <A> Argument type ({@link Void} if statement does not have argument.)
183 * @param <D> Class representing declared version of this statement.
185 public abstract static class DefaultArgument<A, D extends DeclaredStatement<A>> extends Default<A, D> {
186 public abstract static class WithSubstatements<A, D extends DeclaredStatement<A>>
187 extends DefaultArgument<A, D> {
188 private final @NonNull Object substatements;
190 protected WithSubstatements(final D declared,
191 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
193 this.substatements = maskList(substatements);
197 public final ImmutableList<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
198 return unmaskList(substatements);
202 protected DefaultArgument(final D declared) {
207 public final A argument() {
208 return getDeclared().argument();
213 * A building block on top of {@link Default}, which adds an explicit argument value, which is not related to the
214 * context. This is mostly useful when the effective argument value reflects additional statements and similar.
216 * @param <A> Argument type ({@link Void} if statement does not have argument.)
217 * @param <D> Class representing declared version of this statement.
219 public abstract static class DefaultWithArgument<A, D extends DeclaredStatement<A>> extends Default<A, D> {
220 public abstract static class WithSubstatements<A, D extends DeclaredStatement<A>>
221 extends DefaultWithArgument<A, D> {
222 private final @NonNull Object substatements;
224 protected WithSubstatements(final D declared, final A argument,
225 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
226 super(declared, argument);
227 this.substatements = maskList(substatements);
231 public final ImmutableList<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
232 return unmaskList(substatements);
236 private final A argument;
238 protected DefaultWithArgument(final D declared, final A argument) {
240 this.argument = argument;
244 public final A argument() {
250 * Stateful version of {@link WithSchemaTree}. Schema tree namespace is eagerly instantiated (and checked).
252 * @param <A> Argument type ({@link Void} if statement does not have argument.)
253 * @param <D> Class representing declared version of this statement.
254 * @param <E> Class representing effective version of this statement.
256 public abstract static class DefaultWithSchemaTree<A, D extends DeclaredStatement<A>,
257 E extends SchemaTreeAwareEffectiveStatement<A, D>> extends WithSchemaTree<A, D, E> {
258 public abstract static class WithSubstatements<A, D extends DeclaredStatement<A>,
259 E extends SchemaTreeAwareEffectiveStatement<A, D>> extends DefaultWithSchemaTree<A, D, E> {
260 private final @NonNull Object substatements;
262 protected WithSubstatements(final D declared,
263 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
264 super(declared, substatements);
265 this.substatements = maskList(substatements);
269 public final ImmutableList<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
270 return unmaskList(substatements);
274 private final @NonNull ImmutableMap<QName, SchemaTreeEffectiveStatement<?>> schemaTree;
275 private final @NonNull D declared;
277 protected DefaultWithSchemaTree(final D declared,
278 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
279 this.declared = requireNonNull(declared);
280 this.schemaTree = ImmutableMap.copyOf(createSchemaTreeNamespace(substatements));
284 public final D getDeclared() {
289 protected final Map<QName, SchemaTreeEffectiveStatement<?>> schemaTreeNamespace() {
295 * Stateful version of {@link WithDataTree}. Schema tree and data tree namespaces are eagerly instantiated
298 * @param <A> Argument type ({@link Void} if statement does not have argument.)
299 * @param <D> Class representing declared version of this statement.
300 * @param <E> Class representing effective version of this statement.
302 public abstract static class DefaultWithDataTree<A, D extends DeclaredStatement<A>,
303 E extends DataTreeAwareEffectiveStatement<A, D>> extends WithDataTree<A, D, E> {
304 public abstract static class WithSubstatements<A, D extends DeclaredStatement<A>,
305 E extends DataTreeAwareEffectiveStatement<A, D>> extends DefaultWithDataTree<A, D, E> {
306 private final @NonNull Object substatements;
308 protected WithSubstatements(final D declared,
309 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
310 super(declared, substatements);
311 this.substatements = maskList(substatements);
315 public final ImmutableList<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
316 return unmaskList(substatements);
320 private final @NonNull ImmutableMap<QName, SchemaTreeEffectiveStatement<?>> schemaTree;
321 private final @NonNull ImmutableMap<QName, DataTreeEffectiveStatement<?>> dataTree;
322 private final @NonNull D declared;
324 protected DefaultWithDataTree(final D declared,
325 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
326 this.declared = requireNonNull(declared);
327 final Map<QName, SchemaTreeEffectiveStatement<?>> schema = createSchemaTreeNamespace(substatements);
328 this.schemaTree = ImmutableMap.copyOf(schema);
329 this.dataTree = createDataTreeNamespace(schema.values(), schemaTree);
333 public final D getDeclared() {
338 protected final Map<QName, SchemaTreeEffectiveStatement<?>> schemaTreeNamespace() {
343 protected final Map<QName, DataTreeEffectiveStatement<?>> dataTreeNamespace() {