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