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.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.StatementSource;
  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.parser.rfc7950.stmt.EffectiveStatementMixins.DataNodeContainerMixin;
  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 Void} 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 StatementSource getStatementSource() {
  50         return StatementSource.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 Void} 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#findDataChildByName(QName)}.
  78          */
  79         protected final Optional<DataSchemaNode> findDataSchemaNode(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 ? Optional.of((DataSchemaNode) child) : Optional.empty();
  84         }
  85
  86         protected abstract Map<QName, SchemaTreeEffectiveStatement<?>> schemaTreeNamespace();
  87     }
  88
  89     /**
  90      * Base stateless superclass form {@link DataTreeAwareEffectiveStatement}s. It maintains the contents of data tree
  91      * namespace based of effective substatements.
  92      *
  93      * @param <A> Argument type ({@link Void} 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 Void} 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         @Override
 128         public final D getDeclared() {
 129             return declared;
 130         }
 131     }
 132
 133     /**
 134      * Utility class for implementing DataNodeContainer-type statements.
 135      */
 136     public abstract static class DefaultDataNodeContainer<A, D extends DeclaredStatement<A>> extends Default<A, D>
 137             implements DataNodeContainerMixin<A, D> {
 138         private final @NonNull ImmutableMap<QName, DataSchemaNode> dataChildren;
 139         private final @NonNull Object substatements;
 140
 141         protected DefaultDataNodeContainer(final D declared,
 142                 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 143             super(declared);
 144             this.substatements = maskList(substatements);
 145
 146             // Note: we do not leak this map, so iteration order does not matter
 147             final Map<QName, DataSchemaNode> tmp = new HashMap<>();
 148
 149             for (EffectiveStatement<?, ?> stmt : effectiveSubstatements()) {
 150                 if (stmt instanceof DataSchemaNode) {
 151                     final DataSchemaNode node = (DataSchemaNode) stmt;
 152                     final QName id = node.getQName();
 153                     final DataSchemaNode prev = tmp.put(id, node);
 154                     if (prev != null) {
 155                         throw new SubstatementIndexingException(
 156                             "Cannot add child with name " + id + ", a conflicting child already exists");
 157                     }
 158                 }
 159             }
 160
 161             dataChildren = ImmutableMap.copyOf(tmp);
 162         }
 163
 164         @Override
 165         public final ImmutableList<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
 166             return unmaskList(substatements);
 167         }
 168
 169         @Override
 170         public final Optional<DataSchemaNode> findDataChildByName(final QName name) {
 171             return Optional.ofNullable(dataChildren.get(requireNonNull(name)));
 172         }
 173     }
 174
 175     /**
 176      * An extra building block on top of {@link Default}, which is wiring {@link #argument()} to the declared statement.
 177      * This is mostly useful for arguments that are not subject to inference transformation -- for example Strings in
 178      * {@code description}, etc. This explicitly is not true of statements which underwent namespace binding via
 179      * {@code uses} or similar.
 180      *
 181      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 182      * @param <D> Class representing declared version of this statement.
 183      */
 184     public abstract static class DefaultArgument<A, D extends DeclaredStatement<A>> extends Default<A, D> {
 185         public abstract static class WithSubstatements<A, D extends DeclaredStatement<A>>
 186                 extends DefaultArgument<A, D> {
 187             private final @NonNull Object substatements;
 188
 189             protected WithSubstatements(final D declared,
 190                     final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 191                 super(declared);
 192                 this.substatements = maskList(substatements);
 193             }
 194
 195             @Override
 196             public final ImmutableList<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
 197                 return unmaskList(substatements);
 198             }
 199         }
 200
 201         protected DefaultArgument(final D declared) {
 202             super(declared);
 203         }
 204
 205         @Override
 206         public final A argument() {
 207             return getDeclared().argument();
 208         }
 209     }
 210
 211     /**
 212      * A building block on top of {@link Default}, which adds an explicit argument value, which is not related to the
 213      * context. This is mostly useful when the effective argument value reflects additional statements and similar.
 214      *
 215      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 216      * @param <D> Class representing declared version of this statement.
 217      */
 218     public abstract static class DefaultWithArgument<A, D extends DeclaredStatement<A>> extends Default<A, D> {
 219         public abstract static class WithSubstatements<A, D extends DeclaredStatement<A>>
 220                 extends DefaultWithArgument<A, D> {
 221             private final @NonNull Object substatements;
 222
 223             protected WithSubstatements(final D declared, final A argument,
 224                     final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 225                 super(declared, argument);
 226                 this.substatements = maskList(substatements);
 227             }
 228
 229             @Override
 230             public final ImmutableList<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
 231                 return unmaskList(substatements);
 232             }
 233         }
 234
 235         private final A argument;
 236
 237         protected DefaultWithArgument(final D declared, final A argument) {
 238             super(declared);
 239             this.argument = argument;
 240         }
 241
 242         @Override
 243         public final A argument() {
 244             return argument;
 245         }
 246     }
 247
 248     /**
 249      * Stateful version of {@link WithSchemaTree}. Schema tree namespace is eagerly instantiated (and checked).
 250      *
 251      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 252      * @param <D> Class representing declared version of this statement.
 253      * @param <E> Class representing effective version of this statement.
 254      */
 255     public abstract static class DefaultWithSchemaTree<A, D extends DeclaredStatement<A>,
 256             E extends SchemaTreeAwareEffectiveStatement<A, D>> extends WithSchemaTree<A, D, E> {
 257         public abstract static class WithSubstatements<A, D extends DeclaredStatement<A>,
 258                 E extends SchemaTreeAwareEffectiveStatement<A, D>> extends DefaultWithSchemaTree<A, D, E> {
 259             private final @NonNull Object substatements;
 260
 261             protected WithSubstatements(final D declared,
 262                     final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 263                 super(declared, substatements);
 264                 this.substatements = maskList(substatements);
 265             }
 266
 267             @Override
 268             public final ImmutableList<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
 269                 return unmaskList(substatements);
 270             }
 271         }
 272
 273         private final @NonNull ImmutableMap<QName, SchemaTreeEffectiveStatement<?>> schemaTree;
 274         private final @NonNull D declared;
 275
 276         protected DefaultWithSchemaTree(final D declared,
 277                 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 278             this.declared = requireNonNull(declared);
 279             this.schemaTree = ImmutableMap.copyOf(createSchemaTreeNamespace(substatements));
 280         }
 281
 282         @Override
 283         public final D getDeclared() {
 284             return declared;
 285         }
 286
 287         @Override
 288         protected final Map<QName, SchemaTreeEffectiveStatement<?>> schemaTreeNamespace() {
 289             return schemaTree;
 290         }
 291     }
 292
 293     /**
 294      * Stateful version of {@link WithDataTree}. Schema tree and data tree namespaces are eagerly instantiated
 295      * (and checked).
 296      *
 297      * @param <A> Argument type ({@link Void} if statement does not have argument.)
 298      * @param <D> Class representing declared version of this statement.
 299      * @param <E> Class representing effective version of this statement.
 300      */
 301     public abstract static class DefaultWithDataTree<A, D extends DeclaredStatement<A>,
 302             E extends DataTreeAwareEffectiveStatement<A, D>> extends WithDataTree<A, D, E> {
 303         public abstract static class WithSubstatements<A, D extends DeclaredStatement<A>,
 304                 E extends DataTreeAwareEffectiveStatement<A, D>> extends DefaultWithDataTree<A, D, E> {
 305             private final @NonNull Object substatements;
 306
 307             protected WithSubstatements(final D declared,
 308                     final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 309                 super(declared, substatements);
 310                 this.substatements = maskList(substatements);
 311             }
 312
 313             @Override
 314             public final ImmutableList<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
 315                 return unmaskList(substatements);
 316             }
 317         }
 318
 319         private final @NonNull ImmutableMap<QName, SchemaTreeEffectiveStatement<?>> schemaTree;
 320         private final @NonNull ImmutableMap<QName, DataTreeEffectiveStatement<?>> dataTree;
 321         private final @NonNull D declared;
 322
 323         protected DefaultWithDataTree(final D declared,
 324                 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 325             this.declared = requireNonNull(declared);
 326             final Map<QName, SchemaTreeEffectiveStatement<?>> schema = createSchemaTreeNamespace(substatements);
 327             this.schemaTree = ImmutableMap.copyOf(schema);
 328             this.dataTree = createDataTreeNamespace(schema.values(), schemaTree);
 329         }
 330
 331         @Override
 332         public final D getDeclared() {
 333             return declared;
 334         }
 335
 336         @Override
 337         protected final Map<QName, SchemaTreeEffectiveStatement<?>> schemaTreeNamespace() {
 338             return schemaTree;
 339         }
 340
 341         @Override
 342         protected final Map<QName, DataTreeEffectiveStatement<?>> dataTreeNamespace() {
 343             return dataTree;
 344         }
 345     }
 346 }