model/yang-model-spi/src/main/java/org/opendaylight/yangtools/yang/model/spi/meta/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.model.spi.meta;
   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.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;
  31
  32 @Beta
  33 public abstract class AbstractUndeclaredEffectiveStatement<A, D extends DeclaredStatement<A>>
  34         extends AbstractEffectiveStatement<A, D>  {
  35     @Override
  36     public final StatementOrigin statementOrigin() {
  37         return StatementOrigin.CONTEXT;
  38     }
  39
  40     @Override
  41     public final D getDeclared() {
  42         return null;
  43     }
  44
  45     /**
  46      * Base stateless superclass form {@link SchemaTreeAwareEffectiveStatement}s. It maintains the contents of schema
  47      * tree namespace based of effective substatements.
  48      *
  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.
  52      */
  53     public abstract static class WithSchemaTree<A, D extends DeclaredStatement<A>,
  54             E extends SchemaTreeAwareEffectiveStatement<A, D>> extends AbstractUndeclaredEffectiveStatement<A, D> {
  55         @Override
  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());
  61             }
  62             return super.getNamespaceContents(namespace);
  63         }
  64
  65         /**
  66          * Indexing support for {@link DataNodeContainer#findDataChildByName(QName)}.
  67          */
  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;
  73         }
  74
  75         protected abstract Map<QName, SchemaTreeEffectiveStatement<?>> schemaTreeNamespace();
  76     }
  77
  78     /**
  79      * Base stateless superclass form {@link DataTreeAwareEffectiveStatement}s. It maintains the contents of data tree
  80      * namespace based of effective substatements.
  81      *
  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.
  85      */
  86     public abstract static class WithDataTree<A, D extends DeclaredStatement<A>,
  87             E extends DataTreeAwareEffectiveStatement<A, D>> extends WithSchemaTree<A, D, E> {
  88         @Override
  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());
  94             }
  95             return super.getNamespaceContents(namespace);
  96         }
  97
  98         protected abstract Map<QName, DataTreeEffectiveStatement<?>> dataTreeNamespace();
  99     }
 100
 101     /**
 102      * Stateful version of {@link WithSchemaTree}. Schema tree namespace is eagerly instantiated (and checked).
 103      *
 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.
 107      */
 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;
 113
 114             protected WithSubstatements(final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 115                 super(substatements);
 116                 this.substatements = maskList(substatements);
 117             }
 118
 119             protected WithSubstatements(final WithSubstatements<A, D, E> original) {
 120                 super(original);
 121                 this.substatements = original.substatements;
 122             }
 123
 124             @Override
 125             public final ImmutableList<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
 126                 return unmaskList(substatements);
 127             }
 128         }
 129
 130         private final @NonNull ImmutableMap<QName, SchemaTreeEffectiveStatement<?>> schemaTree;
 131
 132         protected DefaultWithSchemaTree(final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 133             this.schemaTree = ImmutableMap.copyOf(createSchemaTreeNamespace(substatements));
 134         }
 135
 136         protected DefaultWithSchemaTree(final DefaultWithSchemaTree<A, D, E> original) {
 137             this.schemaTree = original.schemaTree;
 138         }
 139
 140         @Override
 141         protected final Map<QName, SchemaTreeEffectiveStatement<?>> schemaTreeNamespace() {
 142             return schemaTree;
 143         }
 144     }
 145
 146     /**
 147      * Stateful version of {@link WithDataTree}. Schema tree and data tree namespaces are eagerly instantiated
 148      * (and checked).
 149      *
 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.
 153      */
 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;
 159
 160             protected WithSubstatements(final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 161                 super(substatements);
 162                 this.substatements = maskList(substatements);
 163             }
 164
 165             protected WithSubstatements(final WithSubstatements<A, D, E> original) {
 166                 super(original);
 167                 this.substatements = original.substatements;
 168             }
 169
 170             @Override
 171             public final ImmutableList<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
 172                 return unmaskList(substatements);
 173             }
 174         }
 175
 176         private final @NonNull ImmutableMap<QName, SchemaTreeEffectiveStatement<?>> schemaTree;
 177         private final @NonNull ImmutableMap<QName, DataTreeEffectiveStatement<?>> dataTree;
 178
 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);
 183         }
 184
 185         protected DefaultWithDataTree(final DefaultWithDataTree<A, D, E> original) {
 186             this.schemaTree = original.schemaTree;
 187             this.dataTree = original.dataTree;
 188         }
 189
 190         @Override
 191         protected final Map<QName, SchemaTreeEffectiveStatement<?>> schemaTreeNamespace() {
 192             return schemaTree;
 193         }
 194
 195         @Override
 196         protected final Map<QName, DataTreeEffectiveStatement<?>> dataTreeNamespace() {
 197             return dataTree;
 198         }
 199     }
 200 }