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 java.util.Map;
  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
  33 @Beta
  34 public abstract class AbstractUndeclaredEffectiveStatement<A, D extends DeclaredStatement<A>>
  35         extends AbstractEffectiveStatement<A, D>  {
  36     @Override
  37     public final D getDeclared() {
  38         return null;
  39     }
  40
  41     /**
  42      * Base stateless superclass form {@link SchemaTreeAwareEffectiveStatement}s. It maintains the contents of schema
  43      * tree namespace based of effective substatements.
  44      *
  45      * @param <A> Argument type ({@link Empty} if statement does not have argument.)
  46      * @param <D> Class representing declared version of this statement.
  47      */
  48     public abstract static class WithSchemaTree<A, D extends DeclaredStatement<A>>
  49             extends AbstractUndeclaredEffectiveStatement<A, D> {
  50         @Override
  51         @SuppressWarnings("unchecked")
  52         protected <K, V, N extends IdentifierNamespace<K, V>> Optional<? extends Map<K, V>> getNamespaceContents(
  53                 final Class<N> namespace) {
  54             if (SchemaTreeNamespace.class.equals(namespace)) {
  55                 return Optional.of((Map<K, V>) schemaTreeNamespace());
  56             }
  57             return super.getNamespaceContents(namespace);
  58         }
  59
  60         /**
  61          * Indexing support for {@link DataNodeContainer#findDataChildByName(QName)}.
  62          */
  63         protected final @Nullable DataSchemaNode dataSchemaNode(final QName name) {
  64             // Only DataNodeContainer subclasses should be calling this method
  65             verify(this instanceof DataNodeContainer);
  66             final SchemaTreeEffectiveStatement<?> child = schemaTreeNamespace().get(requireNonNull(name));
  67             return child instanceof DataSchemaNode ? (DataSchemaNode) child : null;
  68         }
  69
  70         protected abstract Map<QName, SchemaTreeEffectiveStatement<?>> schemaTreeNamespace();
  71     }
  72
  73     /**
  74      * Base stateless superclass form {@link DataTreeAwareEffectiveStatement}s. It maintains the contents of data tree
  75      * namespace based of effective substatements.
  76      *
  77      * @param <A> Argument type ({@link Empty} if statement does not have argument.)
  78      * @param <D> Class representing declared version of this statement.
  79      */
  80     public abstract static class WithDataTree<A, D extends DeclaredStatement<A>> extends WithSchemaTree<A, D> {
  81         @Override
  82         @SuppressWarnings("unchecked")
  83         protected <K, V, N extends IdentifierNamespace<K, V>> Optional<? extends Map<K, V>> getNamespaceContents(
  84                 final Class<N> namespace) {
  85             if (DataTreeNamespace.class.equals(namespace)) {
  86                 return Optional.of((Map<K, V>) dataTreeNamespace());
  87             }
  88             return super.getNamespaceContents(namespace);
  89         }
  90
  91         protected abstract Map<QName, DataTreeEffectiveStatement<?>> dataTreeNamespace();
  92     }
  93
  94     /**
  95      * Stateful version of {@link WithSchemaTree}. Schema tree namespace is eagerly instantiated (and checked).
  96      *
  97      * @param <A> Argument type ({@link Empty} if statement does not have argument.)
  98      * @param <D> Class representing declared version of this statement.
  99      */
 100     public abstract static class DefaultWithSchemaTree<A, D extends DeclaredStatement<A>> extends WithSchemaTree<A, D> {
 101         private final @NonNull Map<QName, SchemaTreeEffectiveStatement<?>> schemaTree;
 102         private final @NonNull Object substatements;
 103
 104         protected DefaultWithSchemaTree(final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 105             this.substatements = maskList(substatements);
 106             this.schemaTree = immutableNamespaceOf(createSchemaTreeNamespace(substatements));
 107         }
 108
 109         protected DefaultWithSchemaTree(final DefaultWithSchemaTree<A, D> original) {
 110             this.schemaTree = original.schemaTree;
 111             this.substatements = original.substatements;
 112         }
 113
 114         @Override
 115         public final ImmutableList<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
 116             return unmaskList(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 Empty} if statement does not have argument.)
 130      * @param <D> Class representing declared version of this statement.
 131      */
 132     public abstract static class DefaultWithDataTree<A, D extends DeclaredStatement<A>> extends WithDataTree<A, D> {
 133         private final @NonNull Map<QName, SchemaTreeEffectiveStatement<?>> schemaTree;
 134         private final @NonNull Map<QName, DataTreeEffectiveStatement<?>> dataTree;
 135         private final @NonNull Object substatements;
 136
 137         protected DefaultWithDataTree(final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 138             final Map<QName, SchemaTreeEffectiveStatement<?>> schema = createSchemaTreeNamespace(substatements);
 139             this.schemaTree = immutableNamespaceOf(schema);
 140             this.dataTree = createDataTreeNamespace(schema.values(), schemaTree);
 141             this.substatements = maskList(substatements);
 142         }
 143
 144         protected DefaultWithDataTree(final DefaultWithDataTree<A, D> original) {
 145             this.schemaTree = original.schemaTree;
 146             this.dataTree = original.dataTree;
 147             this.substatements = original.substatements;
 148         }
 149
 150         @Override
 151         public final ImmutableList<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
 152             return unmaskList(substatements);
 153         }
 154
 155         @Override
 156         protected final Map<QName, SchemaTreeEffectiveStatement<?>> schemaTreeNamespace() {
 157             return schemaTree;
 158         }
 159
 160         @Override
 161         protected final Map<QName, DataTreeEffectiveStatement<?>> dataTreeNamespace() {
 162             return dataTree;
 163         }
 164     }
 165 }