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.Empty;
  21 import org.opendaylight.yangtools.yang.common.QName;
  22 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  23 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  24 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  25 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  26 import org.opendaylight.yangtools.yang.model.api.meta.IdentifierNamespace;
  27 import org.opendaylight.yangtools.yang.model.api.meta.StatementOrigin;
  28 import org.opendaylight.yangtools.yang.model.api.stmt.DataTreeAwareEffectiveStatement;
  29 import org.opendaylight.yangtools.yang.model.api.stmt.DataTreeEffectiveStatement;
  30 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeAwareEffectiveStatement;
  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 StatementOrigin statementOrigin() {
  38         return StatementOrigin.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 Empty} 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 @Nullable DataSchemaNode dataSchemaNode(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 ? (DataSchemaNode) child : null;
  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 Empty} 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 Empty} 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         public abstract static class WithSubstatements<A, D extends DeclaredStatement<A>,
 112                 E extends SchemaTreeAwareEffectiveStatement<A, D>> extends DefaultWithSchemaTree<A, D, E> {
 113             private final @NonNull Object substatements;
 114
 115             protected WithSubstatements(final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 116                 super(substatements);
 117                 this.substatements = maskList(substatements);
 118             }
 119
 120             protected WithSubstatements(final WithSubstatements<A, D, E> original) {
 121                 super(original);
 122                 this.substatements = original.substatements;
 123             }
 124
 125             @Override
 126             public final ImmutableList<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
 127                 return unmaskList(substatements);
 128             }
 129         }
 130
 131         private final @NonNull ImmutableMap<QName, SchemaTreeEffectiveStatement<?>> schemaTree;
 132
 133         protected DefaultWithSchemaTree(final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 134             this.schemaTree = ImmutableMap.copyOf(createSchemaTreeNamespace(substatements));
 135         }
 136
 137         protected DefaultWithSchemaTree(final DefaultWithSchemaTree<A, D, E> original) {
 138             this.schemaTree = original.schemaTree;
 139         }
 140
 141         @Override
 142         protected final Map<QName, SchemaTreeEffectiveStatement<?>> schemaTreeNamespace() {
 143             return schemaTree;
 144         }
 145     }
 146
 147     /**
 148      * Stateful version of {@link WithDataTree}. Schema tree and data tree namespaces are eagerly instantiated
 149      * (and checked).
 150      *
 151      * @param <A> Argument type ({@link Empty} if statement does not have argument.)
 152      * @param <D> Class representing declared version of this statement.
 153      * @param <E> Class representing effective version of this statement.
 154      */
 155     public abstract static class DefaultWithDataTree<A, D extends DeclaredStatement<A>,
 156             E extends DataTreeAwareEffectiveStatement<A, D>> extends WithDataTree<A, D, E> {
 157         public abstract static class WithSubstatements<A, D extends DeclaredStatement<A>,
 158                 E extends DataTreeAwareEffectiveStatement<A, D>> extends DefaultWithDataTree<A, D, E> {
 159             private final @NonNull Object substatements;
 160
 161             protected WithSubstatements(final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 162                 super(substatements);
 163                 this.substatements = maskList(substatements);
 164             }
 165
 166             protected WithSubstatements(final WithSubstatements<A, D, E> original) {
 167                 super(original);
 168                 this.substatements = original.substatements;
 169             }
 170
 171             @Override
 172             public final ImmutableList<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
 173                 return unmaskList(substatements);
 174             }
 175         }
 176
 177         private final @NonNull ImmutableMap<QName, SchemaTreeEffectiveStatement<?>> schemaTree;
 178         private final @NonNull ImmutableMap<QName, DataTreeEffectiveStatement<?>> dataTree;
 179
 180         protected DefaultWithDataTree(final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 181             final Map<QName, SchemaTreeEffectiveStatement<?>> schema = createSchemaTreeNamespace(substatements);
 182             this.schemaTree = ImmutableMap.copyOf(schema);
 183             this.dataTree = createDataTreeNamespace(schema.values(), schemaTree);
 184         }
 185
 186         protected DefaultWithDataTree(final DefaultWithDataTree<A, D, E> original) {
 187             this.schemaTree = original.schemaTree;
 188             this.dataTree = original.dataTree;
 189         }
 190
 191         @Override
 192         protected final Map<QName, SchemaTreeEffectiveStatement<?>> schemaTreeNamespace() {
 193             return schemaTree;
 194         }
 195
 196         @Override
 197         protected final Map<QName, DataTreeEffectiveStatement<?>> dataTreeNamespace() {
 198             return dataTree;
 199         }
 200     }
 201 }