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>, StmtContextCompat {
  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     /**
 143      * Returns the model root for this statement.
 144      *
 145      * @return root context of statement
 146      */
 147     @NonNull RootStmtContext<?, ?, ?> getRoot();
 148
 149     /**
 150      * Return declared substatements. These are the statements which are explicitly written in the source model.
 151      *
 152      * @return Collection of declared substatements
 153      */
 154     @NonNull Collection<? extends StmtContext<?, ?, ?>> declaredSubstatements();
 155
 156     /**
 157      * Return effective substatements. These are the statements which are added as this statement's substatements
 158      * complete their effective model phase.
 159      *
 160      * @return Collection of declared substatements
 161      */
 162     @NonNull Collection<? extends StmtContext<?, ?, ?>> effectiveSubstatements();
 163
 164     default Iterable<? extends StmtContext<?, ?, ?>> allSubstatements() {
 165         return Iterables.concat(declaredSubstatements(), effectiveSubstatements());
 166     }
 167
 168     default Stream<? extends StmtContext<?, ?, ?>> allSubstatementsStream() {
 169         return Streams.concat(declaredSubstatements().stream(), effectiveSubstatements().stream());
 170     }
 171
 172     /**
 173      * Builds {@link DeclaredStatement} for statement context.
 174      */
 175     D buildDeclared();
 176
 177     /**
 178      * Builds {@link EffectiveStatement} for statement context.
 179      */
 180     E buildEffective();
 181
 182     boolean isSupportedToBuildEffective();
 183
 184     boolean isSupportedByFeatures();
 185
 186     Collection<? extends StmtContext<?, ?, ?>> getEffectOfStatement();
 187
 188     /*
 189      * FIXME: YANGTOOLS-784: the next three methods are closely related to the copy process:
 190      *        - copyHistory() is a brief summary of what went on
 191      *        - getOriginalContext() points to the CopyHistory.ORIGINAL
 192      *        - getPreviousCopyCtx() points to the immediate predecessor forming a singly-linked list terminated
 193      *          at getOriginalContext()
 194      *
 195      *        When implementing YANGTOOLS-784, this needs to be taken into account and properly forwarded through
 196      *        intermediate MutableTrees. Also note this closely relates to current namespace context, as taken into
 197      *        account when creating the argument. At least parts of this are only needed during buildEffective()
 198      *        and hence should become arguments to that method.
 199      */
 200
 201     /**
 202      * Return the statement context of the original definition, if this statement is an instantiated copy.
 203      *
 204      * @return Original definition, if this statement was copied.
 205      */
 206     Optional<StmtContext<A, D, E>> getOriginalCtx();
 207
 208     /**
 209      * Return the context of the previous copy of this statement -- effectively walking towards the source origin
 210      * of this statement.
 211      *
 212      * @return Context of the previous copy of this statement, if this statement has been copied.
 213      */
 214     Optional<StmtContext<A, D, E>> getPreviousCopyCtx();
 215
 216     ModelProcessingPhase getCompletedPhase();
 217
 218     /**
 219      * An mutable view of an inference context associated with an instance of a statement.
 220      *
 221      * @param <A> Argument type
 222      * @param <D> Declared Statement representation
 223      * @param <E> Effective Statement representation
 224      */
 225     interface Mutable<A, D extends DeclaredStatement<A>, E extends EffectiveStatement<A, D>>
 226             extends StmtContext<A, D, E> {
 227
 228         @Override
 229         Mutable<?, ?, ?> getParentContext();
 230
 231         @Override
 232         default Mutable<?, ?, ?> coerceParentContext() {
 233             return verifyNotNull(getParentContext(), "Root context %s does not have a parent", this);
 234         }
 235
 236         /**
 237          * Associate a value with a key within a namespace.
 238          *
 239          * @param type Namespace type
 240          * @param key Key
 241          * @param value value
 242          * @param <K> namespace key type
 243          * @param <V> namespace value type
 244          * @param <N> namespace type
 245          * @param <T> key type
 246          * @param <U> value type
 247          * @throws NamespaceNotAvailableException when the namespace is not available.
 248          */
 249         <K, V, T extends K, U extends V, N extends IdentifierNamespace<K, V>> void addToNs(Class<@NonNull N> type,
 250                 T key, U value);
 251
 252         @Override
 253         RootStmtContext.Mutable<?, ?, ?> getRoot();
 254
 255         /**
 256          * Create a child sub-statement, which is a child of this statement, inheriting all attributes from specified
 257          * child and recording copy type. Resulting object may only be added as a child of this statement.
 258          *
 259          * @param stmt Statement to be used as a template
 260          * @param type Type of copy to record in history
 261          * @param targetModule Optional new target module
 262          * @return copy of statement considering {@link CopyType} (augment, uses)
 263          *
 264          * @throws IllegalArgumentException if stmt cannot be copied into this statement, for example because it comes
 265          *                                  from an alien implementation.
 266          * @throws org.opendaylight.yangtools.yang.parser.spi.source.SourceException instance of SourceException
 267          */
 268         Mutable<?, ?, ?> childCopyOf(StmtContext<?, ?, ?> stmt, CopyType type, @Nullable QNameModule targetModule);
 269
 270         /**
 271          * Create a child sub-statement, which is a child of this statement, inheriting all attributes from specified
 272          * child and recording copy type. Resulting object may only be added as a child of this statement.
 273          *
 274          * @param stmt Statement to be used as a template
 275          * @param type Type of copy to record in history
 276          * @return copy of statement considering {@link CopyType} (augment, uses)
 277          *
 278          * @throws IllegalArgumentException if stmt cannot be copied into this statement, for example because it comes
 279          *                                  from an alien implementation.
 280          * @throws org.opendaylight.yangtools.yang.parser.spi.source.SourceException instance of SourceException
 281          */
 282         default Mutable<?, ?, ?> childCopyOf(final StmtContext<?, ?, ?> stmt, final CopyType type) {
 283             return childCopyOf(stmt, type, null);
 284         }
 285
 286         /**
 287          * Create a replica of this statement as a substatement of specified {@code parent}. The replica must not be
 288          * modified and acts as a source of {@link EffectiveStatement} from outside of {@code parent}'s subtree.
 289          *
 290          * @param parent Parent of the replica statement
 291          * @return replica of this statement
 292          * @throws IllegalArgumentException if this statement cannot be replicated into parent, for example because it
 293          *                                  comes from an alien implementation.
 294          */
 295         @NonNull Mutable<A, D, E> replicaAsChildOf(Mutable<?, ?, ?> parent);
 296
 297         @Beta
 298         @NonNull Optional<? extends Mutable<?, ?, ?>> copyAsChildOf(Mutable<?, ?, ?> parent, CopyType type,
 299                 @Nullable QNameModule targetModule);
 300
 301         @Override
 302         default Collection<? extends StmtContext<?, ?, ?>> declaredSubstatements() {
 303             return mutableDeclaredSubstatements();
 304         }
 305
 306         @NonNull Collection<? extends Mutable<?, ?, ?>> mutableDeclaredSubstatements();
 307
 308         @Override
 309         default Collection<? extends StmtContext<?, ?, ?>> effectiveSubstatements() {
 310             return mutableEffectiveSubstatements();
 311         }
 312
 313         @NonNull Collection<? extends Mutable<?, ?, ?>> mutableEffectiveSubstatements();
 314
 315         /**
 316          * Create a new inference action to be executed during specified phase. The action cannot be cancelled
 317          * and will be executed even if its definition remains incomplete. The specified phase cannot complete until
 318          * this action is resolved. If the action cannot be resolved, model processing will fail.
 319          *
 320          * @param phase Target phase in which the action will resolved.
 321          * @return A new action builder.
 322          * @throws NullPointerException if the specified phase is null
 323          */
 324         @NonNull ModelActionBuilder newInferenceAction(@NonNull ModelProcessingPhase phase);
 325
 326         /**
 327          * Adds s statement to namespace map with a key.
 328          *
 329          * @param namespace
 330          *            {@link StatementNamespace} child that determines namespace to be added to
 331          * @param key
 332          *            of type according to namespace class specification
 333          * @param stmt
 334          *            to be added to namespace map
 335          */
 336         <K, KT extends K, N extends StatementNamespace<K, ?, ?>> void addContext(Class<@NonNull N> namespace, KT key,
 337                 StmtContext<?, ?, ?> stmt);
 338
 339         /**
 340          * Set version of root statement context.
 341          *
 342          * @param version
 343          *            of root statement context
 344          */
 345         void setRootVersion(YangVersion version);
 346
 347         /**
 348          * Add mutable statement to seal. Each mutable statement must be sealed
 349          * as the last step of statement parser processing.
 350          *
 351          * @param mutableStatement
 352          *            mutable statement which should be sealed
 353          */
 354         void addMutableStmtToSeal(MutableStatement mutableStatement);
 355
 356         /**
 357          * Add required module. Based on these dependencies are collected required sources from library sources.
 358          *
 359          * @param dependency
 360          *            SourceIdentifier of module required by current root
 361          *            context
 362          */
 363         /*
 364          * FIXME: this method is used solely during SOURCE_PRE_LINKAGE reactor phase and does not have a corresponding
 365          *        getter -- which makes it rather strange. At some point this method needs to be deprecated and its
 366          *        users migrated to use proper global namespace.
 367          */
 368         void addRequiredSource(SourceIdentifier dependency);
 369
 370         void addAsEffectOfStatement(StmtContext<?, ?, ?> ctx);
 371
 372         void addAsEffectOfStatement(Collection<? extends StmtContext<?, ?, ?>> ctxs);
 373
 374         /**
 375          * Set identifier of current root context.
 376          *
 377          * @param identifier
 378          *            of current root context, must not be null
 379          */
 380         void setRootIdentifier(SourceIdentifier identifier);
 381
 382         void setIsSupportedToBuildEffective(boolean isSupportedToBuild);
 383     }
 384
 385     /**
 386      * Search of any child statement context of specified type and return its argument. If such a statement exists, it
 387      * is assumed to have the right argument. Users should be careful to use this method for statements which have
 388      * cardinality {@code 0..1}, otherwise this method can return any one of the statement's argument.
 389      *
 390      * <p>
 391      * The default implementation defers to
 392      * {@link StmtContextDefaults#findSubstatementArgument(StmtContext, Class)}, subclasses are expected to provide
 393      * optimized implementation if possible.
 394      *
 395      * @param <X> Substatement argument type
 396      * @param <Z> Substatement effective statement representation
 397      * @param type Effective statement representation being look up
 398      * @return {@link Optional#empty()} if no statement exists, otherwise the argument value
 399      */
 400     default <X, Z extends EffectiveStatement<X, ?>> @NonNull Optional<X> findSubstatementArgument(
 401             final @NonNull Class<Z> type) {
 402         return StmtContextDefaults.findSubstatementArgument(this, type);
 403     }
 404
 405     /**
 406      * Check if there is any child statement context of specified type.
 407      *
 408      * <p>
 409      * The default implementation defers to {@link StmtContextDefaults#hasSubstatement(StmtContext, Class)},
 410      * subclasses are expected to provide optimized implementation if possible.
 411      *
 412      * @param type Effective statement representation being look up
 413      * @return True if such a child statement exists, false otherwise
 414      */
 415     default boolean hasSubstatement(final @NonNull Class<? extends EffectiveStatement<?, ?>> type) {
 416         return StmtContextDefaults.hasSubstatement(this, type);
 417     }
 418 }