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