yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/AbstractUndeclaredEffectiveStatement.java

   1 /*
   2  * Copyright (c) 2020 PANTHEON.tech, s.r.o. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.yangtools.yang.parser.rfc7950.stmt;
   9
  10 import static com.google.common.base.Verify.verify;
  11 import static java.util.Objects.requireNonNull;
  12
  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.Map;
  17 import java.util.Optional;
  18 import org.eclipse.jdt.annotation.NonNull;
  19 import org.opendaylight.yangtools.yang.common.QName;
  20 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  21 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  22 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  23 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  24 import org.opendaylight.yangtools.yang.model.api.meta.IdentifierNamespace;
  25 import org.opendaylight.yangtools.yang.model.api.meta.StatementSource;
  26 import org.opendaylight.yangtools.yang.model.api.stmt.DataTreeAwareEffectiveStatement;
  27 import org.opendaylight.yangtools.yang.model.api.stmt.DataTreeEffectiveStatement;
  28 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeAwareEffectiveStatement;
  29 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeEffectiveStatement;
  30 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  31 import org.opendaylight.yangtools.yang.parser.spi.source.StatementSourceReference;
  32
  33 @Beta
  34 public abstract class AbstractUndeclaredEffectiveStatement<A, D extends DeclaredStatement<A>>
  35         extends AbstractEffectiveStatement<A, D>  {
  36     @Override
  37     public final StatementSource getStatementSource() {
  38         return StatementSource.CONTEXT;
  39     }
  40
  41     @Override
  42     public final D getDeclared() {
  43         return null;
  44     }
  45
  46     /**
  47      * Base stateless superclass form {@link SchemaTreeAwareEffectiveStatement}s. It maintains the contents of schema
  48      * tree namespace based of effective substatements.
  49      *
  50      * @param <A> Argument type ({@link Void} if statement does not have argument.)
  51      * @param <D> Class representing declared version of this statement.
  52      * @param <E> Class representing effective version of this statement.
  53      */
  54     public abstract static class WithSchemaTree<A, D extends DeclaredStatement<A>,
  55             E extends SchemaTreeAwareEffectiveStatement<A, D>> extends AbstractUndeclaredEffectiveStatement<A, D> {
  56         @Override
  57         @SuppressWarnings("unchecked")
  58         protected <K, V, N extends IdentifierNamespace<K, V>> Optional<? extends Map<K, V>> getNamespaceContents(
  59                 final Class<N> namespace) {
  60             if (SchemaTreeAwareEffectiveStatement.Namespace.class.equals(namespace)) {
  61                 return Optional.of((Map<K, V>) schemaTreeNamespace());
  62             }
  63             return super.getNamespaceContents(namespace);
  64         }
  65
  66         /**
  67          * Indexing support for {@link DataNodeContainer#findDataChildByName(QName)}.
  68          */
  69         protected final Optional<DataSchemaNode> findDataSchemaNode(final QName name) {
  70             // Only DataNodeContainer subclasses should be calling this method
  71             verify(this instanceof DataNodeContainer);
  72             final SchemaTreeEffectiveStatement<?> child = schemaTreeNamespace().get(requireNonNull(name));
  73             return child instanceof DataSchemaNode ? Optional.of((DataSchemaNode) child) : Optional.empty();
  74         }
  75
  76         protected abstract Map<QName, SchemaTreeEffectiveStatement<?>> schemaTreeNamespace();
  77     }
  78
  79     /**
  80      * Base stateless superclass form {@link DataTreeAwareEffectiveStatement}s. It maintains the contents of data tree
  81      * namespace based of effective substatements.
  82      *
  83      * @param <A> Argument type ({@link Void} if statement does not have argument.)
  84      * @param <D> Class representing declared version of this statement.
  85      * @param <E> Class representing effective version of this statement.
  86      */
  87     public abstract static class WithDataTree<A, D extends DeclaredStatement<A>,
  88             E extends DataTreeAwareEffectiveStatement<A, D>> extends WithSchemaTree<A, D, E> {
  89         @Override
  90         @SuppressWarnings("unchecked")
  91         protected <K, V, N extends IdentifierNamespace<K, V>> Optional<? extends Map<K, V>> getNamespaceContents(
  92                 final Class<N> namespace) {
  93             if (DataTreeAwareEffectiveStatement.Namespace.class.equals(namespace)) {
  94                 return Optional.of((Map<K, V>) dataTreeNamespace());
  95             }
  96             return super.getNamespaceContents(namespace);
  97         }
  98
  99         protected abstract Map<QName, DataTreeEffectiveStatement<?>> dataTreeNamespace();
 100     }
 101
 102     /**
 103      * Stateful version of {@link WithSchemaTree}. Schema tree namespace is eagerly instantiated (and checked).
 104      *
 105      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 106      * @param <D> Class representing declared version of this statement.
 107      * @param <E> Class representing effective version of this statement.
 108      */
 109     public abstract static class DefaultWithSchemaTree<A, D extends DeclaredStatement<A>,
 110             E extends SchemaTreeAwareEffectiveStatement<A, D>> extends WithSchemaTree<A, D, E> {
 111         private final @NonNull ImmutableMap<QName, SchemaTreeEffectiveStatement<?>> schemaTree;
 112
 113         protected DefaultWithSchemaTree(final D declared, final StmtContext<?, ?, ?> ctx,
 114                 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 115             this.schemaTree = ImmutableMap.copyOf(AbstractSchemaEffectiveDocumentedNode.createSchemaTreeNamespace(
 116                 ctx.getStatementSourceReference(), substatements));
 117         }
 118
 119         @Override
 120         protected final Map<QName, SchemaTreeEffectiveStatement<?>> schemaTreeNamespace() {
 121             return schemaTree;
 122         }
 123     }
 124
 125     /**
 126      * Stateful version of {@link WithDataTree}. Schema tree and data tree namespaces are eagerly instantiated
 127      * (and checked).
 128      *
 129      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 130      * @param <D> Class representing declared version of this statement.
 131      * @param <E> Class representing effective version of this statement.
 132      */
 133     public abstract static class DefaultWithDataTree<A, D extends DeclaredStatement<A>,
 134             E extends DataTreeAwareEffectiveStatement<A, D>> extends WithDataTree<A, D, E> {
 135         public abstract static class WithSubstatements<A, D extends DeclaredStatement<A>,
 136                 E extends DataTreeAwareEffectiveStatement<A, D>> extends DefaultWithDataTree<A, D, E> {
 137             private final @NonNull Object substatements;
 138
 139             protected WithSubstatements(final StmtContext<?, ?, ?> ctx,
 140                     final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 141                 super(ctx, substatements);
 142                 this.substatements = maskList(substatements);
 143             }
 144
 145             @Override
 146             public final ImmutableList<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
 147                 return unmaskList(substatements);
 148             }
 149         }
 150
 151         private final @NonNull ImmutableMap<QName, SchemaTreeEffectiveStatement<?>> schemaTree;
 152         private final @NonNull ImmutableMap<QName, DataTreeEffectiveStatement<?>> dataTree;
 153
 154         protected DefaultWithDataTree(final StmtContext<?, ?, ?> ctx,
 155                 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 156             final StatementSourceReference ref = ctx.getStatementSourceReference();
 157             final Map<QName, SchemaTreeEffectiveStatement<?>> schema =
 158                     AbstractSchemaEffectiveDocumentedNode.createSchemaTreeNamespace(ref, substatements);
 159             this.schemaTree = ImmutableMap.copyOf(schema);
 160             this.dataTree = AbstractSchemaEffectiveDocumentedNode.createDataTreeNamespace(ref, schema.values(),
 161                 schemaTree);
 162         }
 163
 164         @Override
 165         protected final Map<QName, SchemaTreeEffectiveStatement<?>> schemaTreeNamespace() {
 166             return schemaTree;
 167         }
 168
 169         @Override
 170         protected final Map<QName, DataTreeEffectiveStatement<?>> dataTreeNamespace() {
 171             return dataTree;
 172         }
 173     }
 174 }