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 com.google.common.collect.ImmutableMap;
  16 import java.util.Map;
  17 import java.util.Optional;
  18 import org.eclipse.jdt.annotation.NonNull;
  19 import org.eclipse.jdt.annotation.Nullable;
  20 import org.opendaylight.yangtools.yang.common.Empty;
  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.StatementOrigin;
  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.api.stmt.TypedefNamespace;
  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 Empty} 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 StatementOrigin statementOrigin() {
  51         return StatementOrigin.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 Empty} 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 for {@link DataTreeAwareEffectiveStatement}s. It maintains the contents of data tree
  92      * namespace based of effective substatements.
  93      *
  94      * @param <A> Argument type ({@link Empty} 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 Empty} 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 @NonNull D getDeclared() {
 134             return declared;
 135         }
 136     }
 137
 138     /**
 139      * An extra building block on top of {@link Default}, which is wiring {@link #argument()} to the declared statement.
 140      * This is mostly useful for arguments that are not subject to inference transformation -- for example Strings in
 141      * {@code description}, etc. This explicitly is not true of statements which underwent namespace binding via
 142      * {@code uses} or similar.
 143      *
 144      * @param <A> Argument type ({@link Empty} if statement does not have argument.)
 145      * @param <D> Class representing declared version of this statement.
 146      */
 147     public abstract static class DefaultArgument<A, D extends DeclaredStatement<A>> extends Default<A, D> {
 148         public abstract static class WithSubstatements<A, D extends DeclaredStatement<A>>
 149                 extends DefaultArgument<A, D> {
 150             private final @NonNull Object substatements;
 151
 152             protected WithSubstatements(final D declared,
 153                     final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 154                 super(declared);
 155                 this.substatements = maskList(substatements);
 156             }
 157
 158             protected WithSubstatements(final WithSubstatements<A, D> original) {
 159                 super(original);
 160                 this.substatements = original.substatements;
 161             }
 162
 163             @Override
 164             public final ImmutableList<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
 165                 return unmaskList(substatements);
 166             }
 167         }
 168
 169         protected DefaultArgument(final D declared) {
 170             super(declared);
 171         }
 172
 173         protected DefaultArgument(final DefaultArgument<A, D> original) {
 174             super(original);
 175         }
 176
 177         @Override
 178         public final A argument() {
 179             return getDeclared().argument();
 180         }
 181     }
 182
 183     /**
 184      * A building block on top of {@link Default}, which adds an explicit argument value, which is not related to the
 185      * context. This is mostly useful when the effective argument value reflects additional statements and similar.
 186      *
 187      * @param <A> Argument type ({@link Empty} if statement does not have argument.)
 188      * @param <D> Class representing declared version of this statement.
 189      */
 190     public abstract static class DefaultWithArgument<A, D extends DeclaredStatement<A>> extends Default<A, D> {
 191         public abstract static class WithSubstatements<A, D extends DeclaredStatement<A>>
 192                 extends DefaultWithArgument<A, D> {
 193             private final @NonNull Object substatements;
 194
 195             protected WithSubstatements(final D declared, final A argument,
 196                     final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 197                 super(declared, argument);
 198                 this.substatements = maskList(substatements);
 199             }
 200
 201             @Override
 202             public final ImmutableList<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
 203                 return unmaskList(substatements);
 204             }
 205         }
 206
 207         private final A argument;
 208
 209         protected DefaultWithArgument(final D declared, final A argument) {
 210             super(declared);
 211             this.argument = argument;
 212         }
 213
 214         @Override
 215         public final A argument() {
 216             return argument;
 217         }
 218     }
 219
 220     /**
 221      * Stateful version of {@link WithSchemaTree}. Schema tree namespace is eagerly instantiated (and checked).
 222      *
 223      * @param <A> Argument type ({@link Empty} if statement does not have argument.)
 224      * @param <D> Class representing declared version of this statement.
 225      * @param <E> Class representing effective version of this statement.
 226      */
 227     public abstract static class DefaultWithSchemaTree<A, D extends DeclaredStatement<A>,
 228             E extends SchemaTreeAwareEffectiveStatement<A, D>> extends WithSchemaTree<A, D, E> {
 229         private final @NonNull ImmutableMap<QName, SchemaTreeEffectiveStatement<?>> schemaTree;
 230         private final @NonNull Object substatements;
 231         private final @NonNull D declared;
 232
 233         protected DefaultWithSchemaTree(final D declared,
 234                 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 235             this.declared = requireNonNull(declared);
 236             this.substatements = maskList(substatements);
 237             this.schemaTree = ImmutableMap.copyOf(createSchemaTreeNamespace(substatements));
 238         }
 239
 240         protected DefaultWithSchemaTree(final DefaultWithSchemaTree<A, D, E> original) {
 241             this.declared = original.declared;
 242             this.schemaTree = original.schemaTree;
 243             this.substatements = original.substatements;
 244         }
 245
 246         @Override
 247         public final D getDeclared() {
 248             return declared;
 249         }
 250
 251         @Override
 252         public final ImmutableList<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
 253             return unmaskList(substatements);
 254         }
 255
 256         @Override
 257         protected final Map<QName, SchemaTreeEffectiveStatement<?>> schemaTreeNamespace() {
 258             return schemaTree;
 259         }
 260     }
 261
 262     /**
 263      * Stateful version of {@link WithDataTree}. Schema tree and data tree namespaces are eagerly instantiated
 264      * (and checked).
 265      *
 266      * @param <A> Argument type ({@link Empty} if statement does not have argument.)
 267      * @param <D> Class representing declared version of this statement.
 268      * @param <E> Class representing effective version of this statement.
 269      */
 270     public abstract static class DefaultWithDataTree<A, D extends DeclaredStatement<A>,
 271             E extends DataTreeAwareEffectiveStatement<A, D>> extends WithDataTree<A, D, E> {
 272         public abstract static class WithTypedefNamespace<A, D extends DeclaredStatement<A>,
 273                 E extends DataTreeAwareEffectiveStatement<A, D>> extends DefaultWithDataTree<A, D, E> {
 274             protected WithTypedefNamespace(final D declared,
 275                 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 276                 super(declared, substatements);
 277                 // Consistency check only
 278                 createTypedefNamespace(substatements);
 279             }
 280
 281             protected WithTypedefNamespace(final WithTypedefNamespace<A, D, E> original) {
 282                 super(original);
 283             }
 284
 285             @Override
 286             @SuppressWarnings("unchecked")
 287             protected <K, V, N extends IdentifierNamespace<K, V>> Optional<? extends Map<K, V>> getNamespaceContents(
 288                     final Class<N> namespace) {
 289                 if (TypedefNamespace.class.equals(namespace)) {
 290                     return Optional.of((Map<K, V>) new LinearTypedefNamespace(effectiveSubstatements()));
 291                 }
 292                 return super.getNamespaceContents(namespace);
 293             }
 294         }
 295
 296         private final @NonNull ImmutableMap<QName, SchemaTreeEffectiveStatement<?>> schemaTree;
 297         private final @NonNull ImmutableMap<QName, DataTreeEffectiveStatement<?>> dataTree;
 298         private final @NonNull Object substatements;
 299         private final @NonNull D declared;
 300
 301         protected DefaultWithDataTree(final D declared,
 302                 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 303             this.declared = requireNonNull(declared);
 304             this.substatements = maskList(substatements);
 305
 306             // Note we call schema.values() so we do not retain them, as that is just pure memory overhead
 307             final Map<QName, SchemaTreeEffectiveStatement<?>> schema = createSchemaTreeNamespace(substatements);
 308             this.schemaTree = ImmutableMap.copyOf(schema);
 309             this.dataTree = createDataTreeNamespace(schema.values(), schemaTree);
 310         }
 311
 312         protected DefaultWithDataTree(final DefaultWithDataTree<A, D, E> original) {
 313             this.declared = original.declared;
 314             this.schemaTree = original.schemaTree;
 315             this.dataTree = original.dataTree;
 316             this.substatements = original.substatements;
 317         }
 318
 319         @Override
 320         public final D getDeclared() {
 321             return declared;
 322         }
 323
 324         @Override
 325         public final ImmutableList<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
 326             return unmaskList(substatements);
 327         }
 328
 329         @Override
 330         protected final Map<QName, SchemaTreeEffectiveStatement<?>> schemaTreeNamespace() {
 331             return schemaTree;
 332         }
 333
 334         @Override
 335         protected final Map<QName, DataTreeEffectiveStatement<?>> dataTreeNamespace() {
 336             return dataTree;
 337         }
 338     }
 339 }