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