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