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