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.model.spi.meta;
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;
16 import java.util.Optional;
17 import org.eclipse.jdt.annotation.NonNull;
18 import org.eclipse.jdt.annotation.Nullable;
19 import org.opendaylight.yangtools.yang.common.Empty;
20 import org.opendaylight.yangtools.yang.common.QName;
21 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
22 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
23 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
24 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
25 import org.opendaylight.yangtools.yang.model.api.meta.IdentifierNamespace;
26 import org.opendaylight.yangtools.yang.model.api.stmt.DataTreeAwareEffectiveStatement;
27 import org.opendaylight.yangtools.yang.model.api.stmt.DataTreeAwareEffectiveStatement.DataTreeNamespace;
28 import org.opendaylight.yangtools.yang.model.api.stmt.DataTreeEffectiveStatement;
29 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeAwareEffectiveStatement;
30 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeAwareEffectiveStatement.SchemaTreeNamespace;
31 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeEffectiveStatement;
32 import org.opendaylight.yangtools.yang.model.api.stmt.TypedefNamespace;
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 Empty} 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 abstract @NonNull D getDeclared();
53 * Base stateless superclass form {@link SchemaTreeAwareEffectiveStatement}s. It maintains the contents of schema
54 * tree namespace based of effective substatements.
56 * @param <A> Argument type ({@link Empty} if statement does not have argument.)
57 * @param <D> Class representing declared version of this statement.
59 public abstract static class WithSchemaTree<A, D extends DeclaredStatement<A>>
60 extends AbstractDeclaredEffectiveStatement<A, D> {
62 @SuppressWarnings("unchecked")
63 protected <K, V, N extends IdentifierNamespace<K, V>> Optional<? extends Map<K, V>> getNamespaceContents(
64 final Class<N> namespace) {
65 if (SchemaTreeNamespace.class.equals(namespace)) {
66 return Optional.of((Map<K, V>) schemaTreeNamespace());
68 return super.getNamespaceContents(namespace);
72 * Indexing support for {@link DataNodeContainer#dataChildByName(QName)}.
74 protected final @Nullable DataSchemaNode dataSchemaNode(final QName name) {
75 // Only DataNodeContainer subclasses should be calling this method
76 verify(this instanceof DataNodeContainer);
77 final SchemaTreeEffectiveStatement<?> child = schemaTreeNamespace().get(requireNonNull(name));
78 return child instanceof DataSchemaNode ? (DataSchemaNode) child : null;
81 protected abstract Map<QName, SchemaTreeEffectiveStatement<?>> schemaTreeNamespace();
85 * Base stateless superclass for {@link DataTreeAwareEffectiveStatement}s. It maintains the contents of data tree
86 * namespace based of effective substatements.
88 * @param <A> Argument type ({@link Empty} if statement does not have argument.)
89 * @param <D> Class representing declared version of this statement.
91 public abstract static class WithDataTree<A, D extends DeclaredStatement<A>> extends WithSchemaTree<A, D> {
93 @SuppressWarnings("unchecked")
94 protected <K, V, N extends IdentifierNamespace<K, V>> Optional<? extends Map<K, V>> getNamespaceContents(
95 final Class<N> namespace) {
96 if (DataTreeNamespace.class.equals(namespace)) {
97 return Optional.of((Map<K, V>) dataTreeNamespace());
99 return super.getNamespaceContents(namespace);
102 protected abstract Map<QName, DataTreeEffectiveStatement<?>> dataTreeNamespace();
106 * A stateful version of {@link AbstractDeclaredEffectiveStatement}, which holds (and requires) a declared
109 * @param <A> Argument type ({@link Empty} if statement does not have argument.)
110 * @param <D> Class representing declared version of this statement.
112 public abstract static class Default<A, D extends DeclaredStatement<A>>
113 extends AbstractDeclaredEffectiveStatement<A, D> {
114 private final @NonNull D declared;
116 protected Default(final D declared) {
117 this.declared = requireNonNull(declared);
120 protected Default(final Default<A, D> original) {
121 this.declared = original.declared;
125 public final @NonNull D getDeclared() {
131 * An extra building block on top of {@link Default}, which is wiring {@link #argument()} to the declared statement.
132 * This is mostly useful for arguments that are not subject to inference transformation -- for example Strings in
133 * {@code description}, etc. This explicitly is not true of statements which underwent namespace binding via
134 * {@code uses} or similar.
136 * @param <A> Argument type ({@link Empty} if statement does not have argument.)
137 * @param <D> Class representing declared version of this statement.
139 public abstract static class DefaultArgument<A, D extends DeclaredStatement<A>> extends Default<A, D> {
140 public abstract static class WithSubstatements<A, D extends DeclaredStatement<A>>
141 extends DefaultArgument<A, D> {
142 private final @NonNull Object substatements;
144 protected WithSubstatements(final D declared,
145 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
147 this.substatements = maskList(substatements);
150 protected WithSubstatements(final WithSubstatements<A, D> original) {
152 this.substatements = original.substatements;
156 public final ImmutableList<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
157 return unmaskList(substatements);
161 protected DefaultArgument(final D declared) {
165 protected DefaultArgument(final DefaultArgument<A, D> original) {
170 public final A argument() {
171 return getDeclared().argument();
176 * A building block on top of {@link Default}, which adds an explicit argument value, which is not related to the
177 * context. This is mostly useful when the effective argument value reflects additional statements and similar.
179 * @param <A> Argument type ({@link Empty} if statement does not have argument.)
180 * @param <D> Class representing declared version of this statement.
182 public abstract static class DefaultWithArgument<A, D extends DeclaredStatement<A>> extends Default<A, D> {
183 public abstract static class WithSubstatements<A, D extends DeclaredStatement<A>>
184 extends DefaultWithArgument<A, D> {
185 private final @NonNull Object substatements;
187 protected WithSubstatements(final D declared, final A argument,
188 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
189 super(declared, argument);
190 this.substatements = maskList(substatements);
194 public final ImmutableList<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
195 return unmaskList(substatements);
199 private final A argument;
201 protected DefaultWithArgument(final D declared, final A argument) {
203 this.argument = argument;
207 public final A argument() {
213 * Stateful version of {@link WithSchemaTree}. Schema tree namespace is eagerly instantiated (and checked).
215 * @param <A> Argument type ({@link Empty} if statement does not have argument.)
216 * @param <D> Class representing declared version of this statement.
218 public abstract static class DefaultWithSchemaTree<A, D extends DeclaredStatement<A>> extends WithSchemaTree<A, D> {
219 private final @NonNull Map<QName, SchemaTreeEffectiveStatement<?>> schemaTree;
220 private final @NonNull Object substatements;
221 private final @NonNull D declared;
223 protected DefaultWithSchemaTree(final D declared,
224 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
225 this.declared = requireNonNull(declared);
226 this.substatements = maskList(substatements);
227 this.schemaTree = immutableNamespaceOf(createSchemaTreeNamespace(substatements));
230 protected DefaultWithSchemaTree(final DefaultWithSchemaTree<A, D> original) {
231 this.declared = original.declared;
232 this.schemaTree = original.schemaTree;
233 this.substatements = original.substatements;
237 public final D getDeclared() {
242 public final ImmutableList<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
243 return unmaskList(substatements);
247 protected final Map<QName, SchemaTreeEffectiveStatement<?>> schemaTreeNamespace() {
253 * Stateful version of {@link WithDataTree}. Schema tree and data tree namespaces are eagerly instantiated
256 * @param <A> Argument type ({@link Empty} if statement does not have argument.)
257 * @param <D> Class representing declared version of this statement.
259 public abstract static class DefaultWithDataTree<A, D extends DeclaredStatement<A>> extends WithDataTree<A, D> {
260 public abstract static class WithTypedefNamespace<A, D extends DeclaredStatement<A>>
261 extends DefaultWithDataTree<A, D> {
262 protected WithTypedefNamespace(final D declared,
263 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
264 super(declared, substatements);
265 // Consistency check only
266 createTypedefNamespace(substatements);
269 protected WithTypedefNamespace(final WithTypedefNamespace<A, D> original) {
274 @SuppressWarnings("unchecked")
275 protected <K, V, N extends IdentifierNamespace<K, V>> Optional<? extends Map<K, V>> getNamespaceContents(
276 final Class<N> namespace) {
277 if (TypedefNamespace.class.equals(namespace)) {
278 return Optional.of((Map<K, V>) new LinearTypedefNamespace(effectiveSubstatements()));
280 return super.getNamespaceContents(namespace);
284 private final @NonNull Map<QName, SchemaTreeEffectiveStatement<?>> schemaTree;
285 private final @NonNull Map<QName, DataTreeEffectiveStatement<?>> dataTree;
286 private final @NonNull Object substatements;
287 private final @NonNull D declared;
289 protected DefaultWithDataTree(final D declared,
290 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
291 this.declared = requireNonNull(declared);
292 this.substatements = maskList(substatements);
294 // Note we call schema.values() so we do not retain them, as that is just pure memory overhead
295 final Map<QName, SchemaTreeEffectiveStatement<?>> schema = createSchemaTreeNamespace(substatements);
296 this.schemaTree = immutableNamespaceOf(schema);
297 this.dataTree = createDataTreeNamespace(schema.values(), schemaTree);
300 protected DefaultWithDataTree(final DefaultWithDataTree<A, D> original) {
301 this.declared = original.declared;
302 this.schemaTree = original.schemaTree;
303 this.dataTree = original.dataTree;
304 this.substatements = original.substatements;
308 public final D getDeclared() {
313 public final ImmutableList<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
314 return unmaskList(substatements);
318 protected final Map<QName, SchemaTreeEffectiveStatement<?>> schemaTreeNamespace() {
323 protected final Map<QName, DataTreeEffectiveStatement<?>> dataTreeNamespace() {