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