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;
15 import com.google.common.collect.ImmutableMap;
17 import java.util.Optional;
18 import org.eclipse.jdt.annotation.NonNull;
19 import org.eclipse.jdt.annotation.Nullable;
20 import org.opendaylight.yangtools.yang.common.Empty;
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.StatementOrigin;
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;
34 * Base stateless superclass for statements which (logically) always have an associated {@link DeclaredStatement}. This
35 * is notably not true for all {@code case} statements, some of which may actually be implied.
38 * Note implementations are not strictly required to make the declared statement available, they are free to throw
39 * {@link UnsupportedOperationException} from {@link #getDeclared()}, rendering any services relying on declared
40 * statement to be not available.
42 * @param <A> Argument type ({@link Empty} if statement does not have argument.)
43 * @param <D> Class representing declared version of this statement.
46 public abstract class AbstractDeclaredEffectiveStatement<A, D extends DeclaredStatement<A>>
47 extends AbstractEffectiveStatement<A, D> {
49 public final StatementOrigin statementOrigin() {
50 return StatementOrigin.DECLARATION;
54 public abstract @NonNull D getDeclared();
57 * Base stateless superclass form {@link SchemaTreeAwareEffectiveStatement}s. It maintains the contents of schema
58 * tree namespace based of effective substatements.
60 * @param <A> Argument type ({@link Empty} if statement does not have argument.)
61 * @param <D> Class representing declared version of this statement.
62 * @param <E> Class representing effective version of this statement.
64 public abstract static class WithSchemaTree<A, D extends DeclaredStatement<A>,
65 E extends SchemaTreeAwareEffectiveStatement<A, D>> extends AbstractDeclaredEffectiveStatement<A, D> {
67 @SuppressWarnings("unchecked")
68 protected <K, V, N extends IdentifierNamespace<K, V>> Optional<? extends Map<K, V>> getNamespaceContents(
69 final Class<N> namespace) {
70 if (SchemaTreeAwareEffectiveStatement.Namespace.class.equals(namespace)) {
71 return Optional.of((Map<K, V>) schemaTreeNamespace());
73 return super.getNamespaceContents(namespace);
77 * Indexing support for {@link DataNodeContainer#dataChildByName(QName)}.
79 protected final @Nullable DataSchemaNode dataSchemaNode(final QName name) {
80 // Only DataNodeContainer subclasses should be calling this method
81 verify(this instanceof DataNodeContainer);
82 final SchemaTreeEffectiveStatement<?> child = schemaTreeNamespace().get(requireNonNull(name));
83 return child instanceof DataSchemaNode ? (DataSchemaNode) child : null;
86 protected abstract Map<QName, SchemaTreeEffectiveStatement<?>> schemaTreeNamespace();
90 * Base stateless superclass form {@link DataTreeAwareEffectiveStatement}s. It maintains the contents of data tree
91 * namespace based of effective substatements.
93 * @param <A> Argument type ({@link Empty} if statement does not have argument.)
94 * @param <D> Class representing declared version of this statement.
95 * @param <E> Class representing effective version of this statement.
97 public abstract static class WithDataTree<A, D extends DeclaredStatement<A>,
98 E extends DataTreeAwareEffectiveStatement<A, D>> extends WithSchemaTree<A, D, E> {
100 @SuppressWarnings("unchecked")
101 protected <K, V, N extends IdentifierNamespace<K, V>> Optional<? extends Map<K, V>> getNamespaceContents(
102 final Class<N> namespace) {
103 if (DataTreeAwareEffectiveStatement.Namespace.class.equals(namespace)) {
104 return Optional.of((Map<K, V>) dataTreeNamespace());
106 return super.getNamespaceContents(namespace);
109 protected abstract Map<QName, DataTreeEffectiveStatement<?>> dataTreeNamespace();
113 * A stateful version of {@link AbstractDeclaredEffectiveStatement}, which holds (and requires) a declared
116 * @param <A> Argument type ({@link Empty} if statement does not have argument.)
117 * @param <D> Class representing declared version of this statement.
119 public abstract static class Default<A, D extends DeclaredStatement<A>>
120 extends AbstractDeclaredEffectiveStatement<A, D> {
121 private final @NonNull D declared;
123 protected Default(final D declared) {
124 this.declared = requireNonNull(declared);
127 protected Default(final Default<A, D> original) {
128 this.declared = original.declared;
132 public final @NonNull D getDeclared() {
138 * An extra building block on top of {@link Default}, which is wiring {@link #argument()} to the declared statement.
139 * This is mostly useful for arguments that are not subject to inference transformation -- for example Strings in
140 * {@code description}, etc. This explicitly is not true of statements which underwent namespace binding via
141 * {@code uses} or similar.
143 * @param <A> Argument type ({@link Empty} if statement does not have argument.)
144 * @param <D> Class representing declared version of this statement.
146 public abstract static class DefaultArgument<A, D extends DeclaredStatement<A>> extends Default<A, D> {
147 public abstract static class WithSubstatements<A, D extends DeclaredStatement<A>>
148 extends DefaultArgument<A, D> {
149 private final @NonNull Object substatements;
151 protected WithSubstatements(final D declared,
152 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
154 this.substatements = maskList(substatements);
157 protected WithSubstatements(final WithSubstatements<A, D> original) {
159 this.substatements = original.substatements;
163 public final ImmutableList<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
164 return unmaskList(substatements);
168 protected DefaultArgument(final D declared) {
172 protected DefaultArgument(final DefaultArgument<A, D> original) {
177 public final A argument() {
178 return getDeclared().argument();
183 * A building block on top of {@link Default}, which adds an explicit argument value, which is not related to the
184 * context. This is mostly useful when the effective argument value reflects additional statements and similar.
186 * @param <A> Argument type ({@link Empty} if statement does not have argument.)
187 * @param <D> Class representing declared version of this statement.
189 public abstract static class DefaultWithArgument<A, D extends DeclaredStatement<A>> extends Default<A, D> {
190 public abstract static class WithSubstatements<A, D extends DeclaredStatement<A>>
191 extends DefaultWithArgument<A, D> {
192 private final @NonNull Object substatements;
194 protected WithSubstatements(final D declared, final A argument,
195 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
196 super(declared, argument);
197 this.substatements = maskList(substatements);
201 public final ImmutableList<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
202 return unmaskList(substatements);
206 private final A argument;
208 protected DefaultWithArgument(final D declared, final A argument) {
210 this.argument = argument;
214 public final A argument() {
220 * Stateful version of {@link WithSchemaTree}. Schema tree namespace is eagerly instantiated (and checked).
222 * @param <A> Argument type ({@link Empty} if statement does not have argument.)
223 * @param <D> Class representing declared version of this statement.
224 * @param <E> Class representing effective version of this statement.
226 public abstract static class DefaultWithSchemaTree<A, D extends DeclaredStatement<A>,
227 E extends SchemaTreeAwareEffectiveStatement<A, D>> extends WithSchemaTree<A, D, E> {
228 public abstract static class WithSubstatements<A, D extends DeclaredStatement<A>,
229 E extends SchemaTreeAwareEffectiveStatement<A, D>> extends DefaultWithSchemaTree<A, D, E> {
230 private final @NonNull Object substatements;
232 protected WithSubstatements(final D declared,
233 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
234 super(declared, substatements);
235 this.substatements = maskList(substatements);
238 protected WithSubstatements(final WithSubstatements<A, D, E> original) {
240 this.substatements = original.substatements;
244 public final ImmutableList<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
245 return unmaskList(substatements);
249 private final @NonNull ImmutableMap<QName, SchemaTreeEffectiveStatement<?>> schemaTree;
250 private final @NonNull D declared;
252 protected DefaultWithSchemaTree(final D declared,
253 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
254 this.declared = requireNonNull(declared);
255 this.schemaTree = ImmutableMap.copyOf(createSchemaTreeNamespace(substatements));
258 protected DefaultWithSchemaTree(final DefaultWithSchemaTree<A, D, E> original) {
259 this.declared = original.declared;
260 this.schemaTree = original.schemaTree;
264 public final D getDeclared() {
269 protected final Map<QName, SchemaTreeEffectiveStatement<?>> schemaTreeNamespace() {
275 * Stateful version of {@link WithDataTree}. Schema tree and data tree namespaces are eagerly instantiated
278 * @param <A> Argument type ({@link Empty} if statement does not have argument.)
279 * @param <D> Class representing declared version of this statement.
280 * @param <E> Class representing effective version of this statement.
282 public abstract static class DefaultWithDataTree<A, D extends DeclaredStatement<A>,
283 E extends DataTreeAwareEffectiveStatement<A, D>> extends WithDataTree<A, D, E> {
284 public abstract static class WithSubstatements<A, D extends DeclaredStatement<A>,
285 E extends DataTreeAwareEffectiveStatement<A, D>> extends DefaultWithDataTree<A, D, E> {
286 private final @NonNull Object substatements;
288 protected WithSubstatements(final D declared,
289 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
290 super(declared, substatements);
291 this.substatements = maskList(substatements);
294 protected WithSubstatements(final WithSubstatements<A, D, E> original) {
296 this.substatements = original.substatements;
300 public final ImmutableList<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
301 return unmaskList(substatements);
305 private final @NonNull ImmutableMap<QName, SchemaTreeEffectiveStatement<?>> schemaTree;
306 private final @NonNull ImmutableMap<QName, DataTreeEffectiveStatement<?>> dataTree;
307 private final @NonNull D declared;
309 protected DefaultWithDataTree(final D declared,
310 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
311 this.declared = requireNonNull(declared);
312 final Map<QName, SchemaTreeEffectiveStatement<?>> schema = createSchemaTreeNamespace(substatements);
313 this.schemaTree = ImmutableMap.copyOf(schema);
314 this.dataTree = createDataTreeNamespace(schema.values(), schemaTree);
317 protected DefaultWithDataTree(final DefaultWithDataTree<A, D, E> original) {
318 this.declared = original.declared;
319 this.schemaTree = original.schemaTree;
320 this.dataTree = original.dataTree;
324 public final D getDeclared() {
329 protected final Map<QName, SchemaTreeEffectiveStatement<?>> schemaTreeNamespace() {
334 protected final Map<QName, DataTreeEffectiveStatement<?>> dataTreeNamespace() {