model/yang-model-spi/src/main/java/org/opendaylight/yangtools/yang/model/spi/meta/AbstractDeclaredEffectiveStatement.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 import org.opendaylight.yangtools.yang.model.api.stmt.TypedefNamespace;
  31
  32 /**
  33  * Base stateless superclass for statements which (logically) always have an associated {@link DeclaredStatement}. This
  34  * is notably not true for all {@code case} statements, some of which may actually be implied.
  35  *
  36  * <p>
  37  * Note implementations are not strictly required to make the declared statement available, they are free to throw
  38  * {@link UnsupportedOperationException} from {@link #getDeclared()}, rendering any services relying on declared
  39  * statement to be not available.
  40  *
  41  * @param <A> Argument type ({@link Empty} if statement does not have argument.)
  42  * @param <D> Class representing declared version of this statement.
  43  */
  44 @Beta
  45 public abstract class AbstractDeclaredEffectiveStatement<A, D extends DeclaredStatement<A>>
  46         extends AbstractEffectiveStatement<A, D> {
  47     @Override
  48     public abstract @NonNull D getDeclared();
  49
  50     /**
  51      * Base stateless superclass form {@link SchemaTreeAwareEffectiveStatement}s. It maintains the contents of schema
  52      * tree namespace based of effective substatements.
  53      *
  54      * @param <A> Argument type ({@link Empty} if statement does not have argument.)
  55      * @param <D> Class representing declared version of this statement.
  56      * @param <E> Class representing effective version of this statement.
  57      */
  58     public abstract static class WithSchemaTree<A, D extends DeclaredStatement<A>,
  59             E extends SchemaTreeAwareEffectiveStatement<A, D>> extends AbstractDeclaredEffectiveStatement<A, D> {
  60         @Override
  61         @SuppressWarnings("unchecked")
  62         protected <K, V, N extends IdentifierNamespace<K, V>> Optional<? extends Map<K, V>> getNamespaceContents(
  63                 final Class<N> namespace) {
  64             if (SchemaTreeAwareEffectiveStatement.Namespace.class.equals(namespace)) {
  65                 return Optional.of((Map<K, V>) schemaTreeNamespace());
  66             }
  67             return super.getNamespaceContents(namespace);
  68         }
  69
  70         /**
  71          * Indexing support for {@link DataNodeContainer#dataChildByName(QName)}.
  72          */
  73         protected final @Nullable DataSchemaNode dataSchemaNode(final QName name) {
  74             // Only DataNodeContainer subclasses should be calling this method
  75             verify(this instanceof DataNodeContainer);
  76             final SchemaTreeEffectiveStatement<?> child = schemaTreeNamespace().get(requireNonNull(name));
  77             return child instanceof DataSchemaNode ? (DataSchemaNode) child : null;
  78         }
  79
  80         protected abstract Map<QName, SchemaTreeEffectiveStatement<?>> schemaTreeNamespace();
  81     }
  82
  83     /**
  84      * Base stateless superclass for {@link DataTreeAwareEffectiveStatement}s. It maintains the contents of data tree
  85      * namespace based of effective substatements.
  86      *
  87      * @param <A> Argument type ({@link Empty} if statement does not have argument.)
  88      * @param <D> Class representing declared version of this statement.
  89      * @param <E> Class representing effective version of this statement.
  90      */
  91     public abstract static class WithDataTree<A, D extends DeclaredStatement<A>,
  92             E extends DataTreeAwareEffectiveStatement<A, D>> extends WithSchemaTree<A, D, E> {
  93         @Override
  94         @SuppressWarnings("unchecked")
  95         protected <K, V, N extends IdentifierNamespace<K, V>> Optional<? extends Map<K, V>> getNamespaceContents(
  96                 final Class<N> namespace) {
  97             if (DataTreeAwareEffectiveStatement.Namespace.class.equals(namespace)) {
  98                 return Optional.of((Map<K, V>) dataTreeNamespace());
  99             }
 100             return super.getNamespaceContents(namespace);
 101         }
 102
 103         protected abstract Map<QName, DataTreeEffectiveStatement<?>> dataTreeNamespace();
 104     }
 105
 106     /**
 107      * A stateful version of {@link AbstractDeclaredEffectiveStatement}, which holds (and requires) a declared
 108      * statement.
 109      *
 110      * @param <A> Argument type ({@link Empty} if statement does not have argument.)
 111      * @param <D> Class representing declared version of this statement.
 112      */
 113     public abstract static class Default<A, D extends DeclaredStatement<A>>
 114             extends AbstractDeclaredEffectiveStatement<A, D> {
 115         private final @NonNull D declared;
 116
 117         protected Default(final D declared) {
 118             this.declared = requireNonNull(declared);
 119         }
 120
 121         protected Default(final Default<A, D> original) {
 122             this.declared = original.declared;
 123         }
 124
 125         @Override
 126         public final @NonNull D getDeclared() {
 127             return declared;
 128         }
 129     }
 130
 131     /**
 132      * An extra building block on top of {@link Default}, which is wiring {@link #argument()} to the declared statement.
 133      * This is mostly useful for arguments that are not subject to inference transformation -- for example Strings in
 134      * {@code description}, etc. This explicitly is not true of statements which underwent namespace binding via
 135      * {@code uses} or similar.
 136      *
 137      * @param <A> Argument type ({@link Empty} if statement does not have argument.)
 138      * @param <D> Class representing declared version of this statement.
 139      */
 140     public abstract static class DefaultArgument<A, D extends DeclaredStatement<A>> extends Default<A, D> {
 141         public abstract static class WithSubstatements<A, D extends DeclaredStatement<A>>
 142                 extends DefaultArgument<A, D> {
 143             private final @NonNull Object substatements;
 144
 145             protected WithSubstatements(final D declared,
 146                     final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 147                 super(declared);
 148                 this.substatements = maskList(substatements);
 149             }
 150
 151             protected WithSubstatements(final WithSubstatements<A, D> original) {
 152                 super(original);
 153                 this.substatements = original.substatements;
 154             }
 155
 156             @Override
 157             public final ImmutableList<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
 158                 return unmaskList(substatements);
 159             }
 160         }
 161
 162         protected DefaultArgument(final D declared) {
 163             super(declared);
 164         }
 165
 166         protected DefaultArgument(final DefaultArgument<A, D> original) {
 167             super(original);
 168         }
 169
 170         @Override
 171         public final A argument() {
 172             return getDeclared().argument();
 173         }
 174     }
 175
 176     /**
 177      * A building block on top of {@link Default}, which adds an explicit argument value, which is not related to the
 178      * context. This is mostly useful when the effective argument value reflects additional statements and similar.
 179      *
 180      * @param <A> Argument type ({@link Empty} if statement does not have argument.)
 181      * @param <D> Class representing declared version of this statement.
 182      */
 183     public abstract static class DefaultWithArgument<A, D extends DeclaredStatement<A>> extends Default<A, D> {
 184         public abstract static class WithSubstatements<A, D extends DeclaredStatement<A>>
 185                 extends DefaultWithArgument<A, D> {
 186             private final @NonNull Object substatements;
 187
 188             protected WithSubstatements(final D declared, final A argument,
 189                     final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 190                 super(declared, argument);
 191                 this.substatements = maskList(substatements);
 192             }
 193
 194             @Override
 195             public final ImmutableList<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
 196                 return unmaskList(substatements);
 197             }
 198         }
 199
 200         private final A argument;
 201
 202         protected DefaultWithArgument(final D declared, final A argument) {
 203             super(declared);
 204             this.argument = argument;
 205         }
 206
 207         @Override
 208         public final A argument() {
 209             return argument;
 210         }
 211     }
 212
 213     /**
 214      * Stateful version of {@link WithSchemaTree}. Schema tree namespace is eagerly instantiated (and checked).
 215      *
 216      * @param <A> Argument type ({@link Empty} if statement does not have argument.)
 217      * @param <D> Class representing declared version of this statement.
 218      * @param <E> Class representing effective version of this statement.
 219      */
 220     public abstract static class DefaultWithSchemaTree<A, D extends DeclaredStatement<A>,
 221             E extends SchemaTreeAwareEffectiveStatement<A, D>> extends WithSchemaTree<A, D, E> {
 222         private final @NonNull Map<QName, SchemaTreeEffectiveStatement<?>> schemaTree;
 223         private final @NonNull Object substatements;
 224         private final @NonNull D declared;
 225
 226         protected DefaultWithSchemaTree(final D declared,
 227                 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 228             this.declared = requireNonNull(declared);
 229             this.substatements = maskList(substatements);
 230             this.schemaTree = immutableNamespaceOf(createSchemaTreeNamespace(substatements));
 231         }
 232
 233         protected DefaultWithSchemaTree(final DefaultWithSchemaTree<A, D, E> original) {
 234             this.declared = original.declared;
 235             this.schemaTree = original.schemaTree;
 236             this.substatements = original.substatements;
 237         }
 238
 239         @Override
 240         public final D getDeclared() {
 241             return declared;
 242         }
 243
 244         @Override
 245         public final ImmutableList<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
 246             return unmaskList(substatements);
 247         }
 248
 249         @Override
 250         protected final Map<QName, SchemaTreeEffectiveStatement<?>> schemaTreeNamespace() {
 251             return schemaTree;
 252         }
 253     }
 254
 255     /**
 256      * Stateful version of {@link WithDataTree}. Schema tree and data tree namespaces are eagerly instantiated
 257      * (and checked).
 258      *
 259      * @param <A> Argument type ({@link Empty} if statement does not have argument.)
 260      * @param <D> Class representing declared version of this statement.
 261      * @param <E> Class representing effective version of this statement.
 262      */
 263     public abstract static class DefaultWithDataTree<A, D extends DeclaredStatement<A>,
 264             E extends DataTreeAwareEffectiveStatement<A, D>> extends WithDataTree<A, D, E> {
 265         public abstract static class WithTypedefNamespace<A, D extends DeclaredStatement<A>,
 266                 E extends DataTreeAwareEffectiveStatement<A, D>> extends DefaultWithDataTree<A, D, E> {
 267             protected WithTypedefNamespace(final D declared,
 268                 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 269                 super(declared, substatements);
 270                 // Consistency check only
 271                 createTypedefNamespace(substatements);
 272             }
 273
 274             protected WithTypedefNamespace(final WithTypedefNamespace<A, D, E> original) {
 275                 super(original);
 276             }
 277
 278             @Override
 279             @SuppressWarnings("unchecked")
 280             protected <K, V, N extends IdentifierNamespace<K, V>> Optional<? extends Map<K, V>> getNamespaceContents(
 281                     final Class<N> namespace) {
 282                 if (TypedefNamespace.class.equals(namespace)) {
 283                     return Optional.of((Map<K, V>) new LinearTypedefNamespace(effectiveSubstatements()));
 284                 }
 285                 return super.getNamespaceContents(namespace);
 286             }
 287         }
 288
 289         private final @NonNull Map<QName, SchemaTreeEffectiveStatement<?>> schemaTree;
 290         private final @NonNull Map<QName, DataTreeEffectiveStatement<?>> dataTree;
 291         private final @NonNull Object substatements;
 292         private final @NonNull D declared;
 293
 294         protected DefaultWithDataTree(final D declared,
 295                 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 296             this.declared = requireNonNull(declared);
 297             this.substatements = maskList(substatements);
 298
 299             // Note we call schema.values() so we do not retain them, as that is just pure memory overhead
 300             final Map<QName, SchemaTreeEffectiveStatement<?>> schema = createSchemaTreeNamespace(substatements);
 301             this.schemaTree = immutableNamespaceOf(schema);
 302             this.dataTree = createDataTreeNamespace(schema.values(), schemaTree);
 303         }
 304
 305         protected DefaultWithDataTree(final DefaultWithDataTree<A, D, E> original) {
 306             this.declared = original.declared;
 307             this.schemaTree = original.schemaTree;
 308             this.dataTree = original.dataTree;
 309             this.substatements = original.substatements;
 310         }
 311
 312         @Override
 313         public final D getDeclared() {
 314             return declared;
 315         }
 316
 317         @Override
 318         public final ImmutableList<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
 319             return unmaskList(substatements);
 320         }
 321
 322         @Override
 323         protected final Map<QName, SchemaTreeEffectiveStatement<?>> schemaTreeNamespace() {
 324             return schemaTree;
 325         }
 326
 327         @Override
 328         protected final Map<QName, DataTreeEffectiveStatement<?>> dataTreeNamespace() {
 329             return dataTree;
 330         }
 331     }
 332 }