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.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.meta.StatementOrigin;
27 import org.opendaylight.yangtools.yang.model.api.stmt.DataTreeAwareEffectiveStatement;
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.SchemaTreeEffectiveStatement;
33 public abstract class AbstractUndeclaredEffectiveStatement<A, D extends DeclaredStatement<A>>
34 extends AbstractEffectiveStatement<A, D> {
36 public final StatementOrigin statementOrigin() {
37 return StatementOrigin.CONTEXT;
41 public final D getDeclared() {
46 * Base stateless superclass form {@link SchemaTreeAwareEffectiveStatement}s. It maintains the contents of schema
47 * tree namespace based of effective substatements.
49 * @param <A> Argument type ({@link Void} if statement does not have argument.)
50 * @param <D> Class representing declared version of this statement.
51 * @param <E> Class representing effective version of this statement.
53 public abstract static class WithSchemaTree<A, D extends DeclaredStatement<A>,
54 E extends SchemaTreeAwareEffectiveStatement<A, D>> extends AbstractUndeclaredEffectiveStatement<A, D> {
56 @SuppressWarnings("unchecked")
57 protected <K, V, N extends IdentifierNamespace<K, V>> Optional<? extends Map<K, V>> getNamespaceContents(
58 final Class<N> namespace) {
59 if (SchemaTreeAwareEffectiveStatement.Namespace.class.equals(namespace)) {
60 return Optional.of((Map<K, V>) schemaTreeNamespace());
62 return super.getNamespaceContents(namespace);
66 * Indexing support for {@link DataNodeContainer#findDataChildByName(QName)}.
68 protected final @Nullable DataSchemaNode dataSchemaNode(final QName name) {
69 // Only DataNodeContainer subclasses should be calling this method
70 verify(this instanceof DataNodeContainer);
71 final SchemaTreeEffectiveStatement<?> child = schemaTreeNamespace().get(requireNonNull(name));
72 return child instanceof DataSchemaNode ? (DataSchemaNode) child : null;
75 protected abstract Map<QName, SchemaTreeEffectiveStatement<?>> schemaTreeNamespace();
79 * Base stateless superclass form {@link DataTreeAwareEffectiveStatement}s. It maintains the contents of data tree
80 * namespace based of effective substatements.
82 * @param <A> Argument type ({@link Void} if statement does not have argument.)
83 * @param <D> Class representing declared version of this statement.
84 * @param <E> Class representing effective version of this statement.
86 public abstract static class WithDataTree<A, D extends DeclaredStatement<A>,
87 E extends DataTreeAwareEffectiveStatement<A, D>> extends WithSchemaTree<A, D, E> {
89 @SuppressWarnings("unchecked")
90 protected <K, V, N extends IdentifierNamespace<K, V>> Optional<? extends Map<K, V>> getNamespaceContents(
91 final Class<N> namespace) {
92 if (DataTreeAwareEffectiveStatement.Namespace.class.equals(namespace)) {
93 return Optional.of((Map<K, V>) dataTreeNamespace());
95 return super.getNamespaceContents(namespace);
98 protected abstract Map<QName, DataTreeEffectiveStatement<?>> dataTreeNamespace();
102 * Stateful version of {@link WithSchemaTree}. Schema tree namespace is eagerly instantiated (and checked).
104 * @param <A> Argument type ({@link Void} if statement does not have argument.)
105 * @param <D> Class representing declared version of this statement.
106 * @param <E> Class representing effective version of this statement.
108 public abstract static class DefaultWithSchemaTree<A, D extends DeclaredStatement<A>,
109 E extends SchemaTreeAwareEffectiveStatement<A, D>> extends WithSchemaTree<A, D, E> {
110 public abstract static class WithSubstatements<A, D extends DeclaredStatement<A>,
111 E extends SchemaTreeAwareEffectiveStatement<A, D>> extends DefaultWithSchemaTree<A, D, E> {
112 private final @NonNull Object substatements;
114 protected WithSubstatements(final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
115 super(substatements);
116 this.substatements = maskList(substatements);
119 protected WithSubstatements(final WithSubstatements<A, D, E> original) {
121 this.substatements = original.substatements;
125 public final ImmutableList<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
126 return unmaskList(substatements);
130 private final @NonNull ImmutableMap<QName, SchemaTreeEffectiveStatement<?>> schemaTree;
132 protected DefaultWithSchemaTree(final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
133 this.schemaTree = ImmutableMap.copyOf(createSchemaTreeNamespace(substatements));
136 protected DefaultWithSchemaTree(final DefaultWithSchemaTree<A, D, E> original) {
137 this.schemaTree = original.schemaTree;
141 protected final Map<QName, SchemaTreeEffectiveStatement<?>> schemaTreeNamespace() {
147 * Stateful version of {@link WithDataTree}. Schema tree and data tree namespaces are eagerly instantiated
150 * @param <A> Argument type ({@link Void} if statement does not have argument.)
151 * @param <D> Class representing declared version of this statement.
152 * @param <E> Class representing effective version of this statement.
154 public abstract static class DefaultWithDataTree<A, D extends DeclaredStatement<A>,
155 E extends DataTreeAwareEffectiveStatement<A, D>> extends WithDataTree<A, D, E> {
156 public abstract static class WithSubstatements<A, D extends DeclaredStatement<A>,
157 E extends DataTreeAwareEffectiveStatement<A, D>> extends DefaultWithDataTree<A, D, E> {
158 private final @NonNull Object substatements;
160 protected WithSubstatements(final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
161 super(substatements);
162 this.substatements = maskList(substatements);
165 protected WithSubstatements(final WithSubstatements<A, D, E> original) {
167 this.substatements = original.substatements;
171 public final ImmutableList<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
172 return unmaskList(substatements);
176 private final @NonNull ImmutableMap<QName, SchemaTreeEffectiveStatement<?>> schemaTree;
177 private final @NonNull ImmutableMap<QName, DataTreeEffectiveStatement<?>> dataTree;
179 protected DefaultWithDataTree(final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
180 final Map<QName, SchemaTreeEffectiveStatement<?>> schema = createSchemaTreeNamespace(substatements);
181 this.schemaTree = ImmutableMap.copyOf(schema);
182 this.dataTree = createDataTreeNamespace(schema.values(), schemaTree);
185 protected DefaultWithDataTree(final DefaultWithDataTree<A, D, E> original) {
186 this.schemaTree = original.schemaTree;
187 this.dataTree = original.dataTree;
191 protected final Map<QName, SchemaTreeEffectiveStatement<?>> schemaTreeNamespace() {
196 protected final Map<QName, DataTreeEffectiveStatement<?>> dataTreeNamespace() {