yang/yang-parser-spi/src/main/java/org/opendaylight/yangtools/yang/parser/spi/meta/StmtContext.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. 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.spi.meta;
   9
  10 import static com.google.common.base.Verify.verifyNotNull;
  11
  12 import com.google.common.annotations.Beta;
  13 import com.google.common.base.VerifyException;
  14 import com.google.common.collect.Iterables;
  15 import com.google.common.collect.Streams;
  16 import java.util.Collection;
  17 import java.util.Map;
  18 import java.util.Optional;
  19 import java.util.stream.Stream;
  20 import org.eclipse.jdt.annotation.NonNull;
  21 import org.eclipse.jdt.annotation.Nullable;
  22 import org.opendaylight.yangtools.yang.common.QNameModule;
  23 import org.opendaylight.yangtools.yang.common.YangVersion;
  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.StatementDefinition;
  28 import org.opendaylight.yangtools.yang.model.api.meta.StatementSource;
  29 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
  30 import org.opendaylight.yangtools.yang.parser.spi.source.StatementSourceReference;
  31
  32 /**
  33  * An inference context associated with an instance of a statement.
  34  *
  35  * @param <A> Argument type
  36  * @param <D> Declared Statement representation
  37  * @param <E> Effective Statement representation
  38  */
  39 public interface StmtContext<A, D extends DeclaredStatement<A>, E extends EffectiveStatement<A, D>>
  40         extends BoundStmtCtx<A> {
  41     @Deprecated(forRemoval = true)
  42     default @NonNull StatementDefinition getPublicDefinition() {
  43         return publicDefinition();
  44     }
  45
  46     @Deprecated(forRemoval = true)
  47     default @NonNull StatementSource getStatementSource() {
  48         return source();
  49     }
  50
  51     @Deprecated(forRemoval = true)
  52     default @NonNull StatementSourceReference getStatementSourceReference() {
  53         return sourceReference();
  54     }
  55
  56     /**
  57      * Return the statement argument in literal format.
  58      *
  59      * @return raw statement argument string, or null if this statement does not have an argument.
  60      * @deprecated Use {@link #rawArgument()} instead.
  61      */
  62     @Deprecated(forRemoval = true)
  63     default @Nullable String rawStatementArgument() {
  64         return rawArgument();
  65     }
  66
  67     /**
  68      * Return the statement argument in literal format.
  69      *
  70      * @return raw statement argument string
  71      * @throws VerifyException if this statement does not have an argument
  72      * @deprecated Use {@link #getRawArgument()} instead.
  73      */
  74     @Deprecated(forRemoval = true)
  75     default @NonNull String coerceRawStatementArgument() {
  76         return getRawArgument();
  77     }
  78
  79     /**
  80      * Return the statement argument.
  81      *
  82      * @return statement argument, or null if this statement does not have an argument
  83      * @deprecated Use {@link #argument()} instead.
  84      */
  85     @Deprecated(forRemoval = true)
  86     default @Nullable A getStatementArgument() {
  87         return argument();
  88     }
  89
  90     /**
  91      * Return the statement argument in literal format.
  92      *
  93      * @return raw statement argument string
  94      * @throws VerifyException if this statement does not have an argument
  95      * @deprecated Use {@link #getArgument()} instead.
  96      */
  97     @Deprecated(forRemoval = true)
  98     default @NonNull A coerceStatementArgument() {
  99         return getArgument();
 100     }
 101
 102     /**
 103      * Return the parent statement context, or null if this is the root statement.
 104      *
 105      * @return context of parent of statement, or null if this is the root statement.
 106      */
 107     @Nullable StmtContext<?, ?, ?> getParentContext();
 108
 109     /**
 110      * Return the parent statement context, forcing a VerifyException if this is the root statement.
 111      *
 112      * @return context of parent of statement
 113      * @throws VerifyException if this statement is the root statement
 114      */
 115     default @NonNull StmtContext<?, ?, ?> coerceParentContext() {
 116         return verifyNotNull(getParentContext(), "Root context %s does not have a parent", this);
 117     }
 118
 119     boolean isConfiguration();
 120
 121     boolean isEnabledSemanticVersioning();
 122
 123     /**
 124      * Return a value associated with specified key within a namespace.
 125      *
 126      * @param type Namespace type
 127      * @param key Key
 128      * @param <K> namespace key type
 129      * @param <V> namespace value type
 130      * @param <N> namespace type
 131      * @param <T> key type
 132      * @return Value, or null if there is no element
 133      * @throws NamespaceNotAvailableException when the namespace is not available.
 134      */
 135     <K, V, T extends K, N extends IdentifierNamespace<K, V>> @Nullable V getFromNamespace(Class<@NonNull N> type,
 136             T key);
 137
 138     <K, V, N extends IdentifierNamespace<K, V>> Map<K, V> getAllFromNamespace(Class<N> type);
 139
 140     <K, V, N extends IdentifierNamespace<K, V>> Map<K, V> getAllFromCurrentStmtCtxNamespace(Class<N> type);
 141
 142     @NonNull RootStmtContext<?, ?, ?> getRoot();
 143
 144     /**
 145      * Return declared substatements. These are the statements which are explicitly written in the source model.
 146      *
 147      * @return Collection of declared substatements
 148      */
 149     @NonNull Collection<? extends StmtContext<?, ?, ?>> declaredSubstatements();
 150
 151     /**
 152      * Return effective substatements. These are the statements which are added as this statement's substatements
 153      * complete their effective model phase.
 154      *
 155      * @return Collection of declared substatements
 156      */
 157     @NonNull Collection<? extends StmtContext<?, ?, ?>> effectiveSubstatements();
 158
 159     default Iterable<? extends StmtContext<?, ?, ?>> allSubstatements() {
 160         return Iterables.concat(declaredSubstatements(), effectiveSubstatements());
 161     }
 162
 163     default Stream<? extends StmtContext<?, ?, ?>> allSubstatementsStream() {
 164         return Streams.concat(declaredSubstatements().stream(), effectiveSubstatements().stream());
 165     }
 166
 167     /**
 168      * Builds {@link DeclaredStatement} for statement context.
 169      */
 170     D buildDeclared();
 171
 172     /**
 173      * Builds {@link EffectiveStatement} for statement context.
 174      */
 175     E buildEffective();
 176
 177     boolean isSupportedToBuildEffective();
 178
 179     boolean isSupportedByFeatures();
 180
 181     Collection<? extends StmtContext<?, ?, ?>> getEffectOfStatement();
 182
 183     /*
 184      * FIXME: YANGTOOLS-784: the next three methods are closely related to the copy process:
 185      *        - getCopyHistory() is a brief summary of what went on
 186      *        - getOriginalContext() points to the CopyHistory.ORIGINAL
 187      *        - getPreviousCopyCtx() points to the immediate predecessor forming a singly-linked list terminated
 188      *          at getOriginalContext()
 189      *
 190      *        When implementing YANGTOOLS-784, this needs to be taken into account and properly forwarded through
 191      *        intermediate MutableTrees. Also note this closely relates to current namespace context, as taken into
 192      *        account when creating the argument. At least parts of this are only needed during buildEffective()
 193      *        and hence should become arguments to that method.
 194      */
 195
 196     /**
 197      * Return the executive summary of the copy process that has produced this context.
 198      *
 199      * @return A simplified summary of the copy process.
 200      */
 201     CopyHistory getCopyHistory();
 202
 203     /**
 204      * Return the statement context of the original definition, if this statement is an instantiated copy.
 205      *
 206      * @return Original definition, if this statement was copied.
 207      */
 208     Optional<StmtContext<A, D, E>> getOriginalCtx();
 209
 210     /**
 211      * Return the context of the previous copy of this statement -- effectively walking towards the source origin
 212      * of this statement.
 213      *
 214      * @return Context of the previous copy of this statement, if this statement has been copied.
 215      */
 216     Optional<StmtContext<A, D, E>> getPreviousCopyCtx();
 217
 218     ModelProcessingPhase getCompletedPhase();
 219
 220     /**
 221      * Return version of root statement context.
 222      *
 223      * @return version of root statement context
 224      */
 225     @NonNull YangVersion getRootVersion();
 226
 227     /**
 228      * An mutable view of an inference context associated with an instance of a statement.
 229      *
 230      * @param <A> Argument type
 231      * @param <D> Declared Statement representation
 232      * @param <E> Effective Statement representation
 233      */
 234     interface Mutable<A, D extends DeclaredStatement<A>, E extends EffectiveStatement<A, D>>
 235             extends StmtContext<A, D, E> {
 236
 237         @Override
 238         Mutable<?, ?, ?> getParentContext();
 239
 240         @Override
 241         default Mutable<?, ?, ?> coerceParentContext() {
 242             return verifyNotNull(getParentContext(), "Root context %s does not have a parent", this);
 243         }
 244
 245         /**
 246          * Associate a value with a key within a namespace.
 247          *
 248          * @param type Namespace type
 249          * @param key Key
 250          * @param value value
 251          * @param <K> namespace key type
 252          * @param <V> namespace value type
 253          * @param <N> namespace type
 254          * @param <T> key type
 255          * @param <U> value type
 256          * @throws NamespaceNotAvailableException when the namespace is not available.
 257          */
 258         <K, V, T extends K, U extends V, N extends IdentifierNamespace<K, V>> void addToNs(Class<@NonNull N> type,
 259                 T key, U value);
 260
 261         @Override
 262         RootStmtContext.Mutable<?, ?, ?> getRoot();
 263
 264         /**
 265          * Create a child sub-statement, which is a child of this statement, inheriting all attributes from specified
 266          * child and recording copy type. Resulting object may only be added as a child of this statement.
 267          *
 268          * @param stmt Statement to be used as a template
 269          * @param type Type of copy to record in history
 270          * @param targetModule Optional new target module
 271          * @return copy of statement considering {@link CopyType} (augment, uses)
 272          *
 273          * @throws IllegalArgumentException if stmt cannot be copied into this statement, for example because it comes
 274          *                                  from an alien implementation.
 275          * @throws org.opendaylight.yangtools.yang.parser.spi.source.SourceException instance of SourceException
 276          */
 277         Mutable<?, ?, ?> childCopyOf(StmtContext<?, ?, ?> stmt, CopyType type, @Nullable QNameModule targetModule);
 278
 279         /**
 280          * Create a child sub-statement, which is a child of this statement, inheriting all attributes from specified
 281          * child and recording copy type. Resulting object may only be added as a child of this statement.
 282          *
 283          * @param stmt Statement to be used as a template
 284          * @param type Type of copy to record in history
 285          * @return copy of statement considering {@link CopyType} (augment, uses)
 286          *
 287          * @throws IllegalArgumentException if stmt cannot be copied into this statement, for example because it comes
 288          *                                  from an alien implementation.
 289          * @throws org.opendaylight.yangtools.yang.parser.spi.source.SourceException instance of SourceException
 290          */
 291         default Mutable<?, ?, ?> childCopyOf(final StmtContext<?, ?, ?> stmt, final CopyType type) {
 292             return childCopyOf(stmt, type, null);
 293         }
 294
 295         @Beta
 296         @NonNull Optional<? extends Mutable<?, ?, ?>> copyAsChildOf(Mutable<?, ?, ?> parent, CopyType type,
 297                 @Nullable QNameModule targetModule);
 298
 299         @Override
 300         default Collection<? extends StmtContext<?, ?, ?>> declaredSubstatements() {
 301             return mutableDeclaredSubstatements();
 302         }
 303
 304         @NonNull Collection<? extends Mutable<?, ?, ?>> mutableDeclaredSubstatements();
 305
 306         @Override
 307         default Collection<? extends StmtContext<?, ?, ?>> effectiveSubstatements() {
 308             return mutableEffectiveSubstatements();
 309         }
 310
 311         @NonNull Collection<? extends Mutable<?, ?, ?>> mutableEffectiveSubstatements();
 312
 313         /**
 314          * Create a new inference action to be executed during specified phase. The action cannot be cancelled
 315          * and will be executed even if its definition remains incomplete. The specified phase cannot complete until
 316          * this action is resolved. If the action cannot be resolved, model processing will fail.
 317          *
 318          * @param phase Target phase in which the action will resolved.
 319          * @return A new action builder.
 320          * @throws NullPointerException if the specified phase is null
 321          */
 322         @NonNull ModelActionBuilder newInferenceAction(@NonNull ModelProcessingPhase phase);
 323
 324         /**
 325          * Adds s statement to namespace map with a key.
 326          *
 327          * @param namespace
 328          *            {@link StatementNamespace} child that determines namespace to be added to
 329          * @param key
 330          *            of type according to namespace class specification
 331          * @param stmt
 332          *            to be added to namespace map
 333          */
 334         <K, KT extends K, N extends StatementNamespace<K, ?, ?>> void addContext(Class<@NonNull N> namespace, KT key,
 335                 StmtContext<?, ?, ?> stmt);
 336
 337         /**
 338          * Set version of root statement context.
 339          *
 340          * @param version
 341          *            of root statement context
 342          */
 343         void setRootVersion(YangVersion version);
 344
 345         /**
 346          * Add mutable statement to seal. Each mutable statement must be sealed
 347          * as the last step of statement parser processing.
 348          *
 349          * @param mutableStatement
 350          *            mutable statement which should be sealed
 351          */
 352         void addMutableStmtToSeal(MutableStatement mutableStatement);
 353
 354         /**
 355          * Add required module. Based on these dependencies are collected required sources from library sources.
 356          *
 357          * @param dependency
 358          *            SourceIdentifier of module required by current root
 359          *            context
 360          */
 361         /*
 362          * FIXME: this method is used solely during SOURCE_PRE_LINKAGE reactor phase and does not have a corresponding
 363          *        getter -- which makes it rather strange. At some point this method needs to be deprecated and its
 364          *        users migrated to use proper global namespace.
 365          */
 366         void addRequiredSource(SourceIdentifier dependency);
 367
 368         void addAsEffectOfStatement(StmtContext<?, ?, ?> ctx);
 369
 370         void addAsEffectOfStatement(Collection<? extends StmtContext<?, ?, ?>> ctxs);
 371
 372         /**
 373          * Set identifier of current root context.
 374          *
 375          * @param identifier
 376          *            of current root context, must not be null
 377          */
 378         void setRootIdentifier(SourceIdentifier identifier);
 379
 380         void setIsSupportedToBuildEffective(boolean isSupportedToBuild);
 381     }
 382
 383     /**
 384      * Search of any child statement context of specified type and return its argument. If such a statement exists, it
 385      * is assumed to have the right argument. Users should be careful to use this method for statements which have
 386      * cardinality {@code 0..1}, otherwise this method can return any one of the statement's argument.
 387      *
 388      * <p>
 389      * The default implementation defers to
 390      * {@link StmtContextDefaults#findSubstatementArgument(StmtContext, Class)}, subclasses are expected to provide
 391      * optimized implementation if possible.
 392      *
 393      * @param <X> Substatement argument type
 394      * @param <Z> Substatement effective statement representation
 395      * @param type Effective statement representation being look up
 396      * @return {@link Optional#empty()} if no statement exists, otherwise the argument value
 397      */
 398     default <X, Z extends EffectiveStatement<X, ?>> @NonNull Optional<X> findSubstatementArgument(
 399             final @NonNull Class<Z> type) {
 400         return StmtContextDefaults.findSubstatementArgument(this, type);
 401     }
 402
 403     /**
 404      * Check if there is any child statement context of specified type.
 405      *
 406      * <p>
 407      * The default implementation defers to {@link StmtContextDefaults#hasSubstatement(StmtContext, Class)},
 408      * subclasses are expected to provide optimized implementation if possible.
 409      *
 410      * @param type Effective statement representation being look up
 411      * @return True if such a child statement exists, false otherwise
 412      */
 413     default boolean hasSubstatement(final @NonNull Class<? extends EffectiveStatement<?, ?>> type) {
 414         return StmtContextDefaults.hasSubstatement(this, type);
 415     }
 416 }