2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.yang.parser.spi.meta;
10 import static com.google.common.base.Verify.verifyNotNull;
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;
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;
33 * An inference context associated with an instance of a statement.
35 * @param <A> Argument type
36 * @param <D> Declared Statement representation
37 * @param <E> Effective Statement representation
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();
46 @Deprecated(forRemoval = true)
47 default @NonNull StatementSource getStatementSource() {
51 @Deprecated(forRemoval = true)
52 default @NonNull StatementSourceReference getStatementSourceReference() {
53 return sourceReference();
57 * Return the statement argument in literal format.
59 * @return raw statement argument string, or null if this statement does not have an argument.
60 * @deprecated Use {@link #rawArgument()} instead.
62 @Deprecated(forRemoval = true)
63 default @Nullable String rawStatementArgument() {
68 * Return the statement argument in literal format.
70 * @return raw statement argument string
71 * @throws VerifyException if this statement does not have an argument
72 * @deprecated Use {@link #getRawArgument()} instead.
74 @Deprecated(forRemoval = true)
75 default @NonNull String coerceRawStatementArgument() {
76 return getRawArgument();
80 * Return the statement argument.
82 * @return statement argument, or null if this statement does not have an argument
83 * @deprecated Use {@link #argument()} instead.
85 @Deprecated(forRemoval = true)
86 default @Nullable A getStatementArgument() {
91 * Return the statement argument in literal format.
93 * @return raw statement argument string
94 * @throws VerifyException if this statement does not have an argument
95 * @deprecated Use {@link #getArgument()} instead.
97 @Deprecated(forRemoval = true)
98 default @NonNull A coerceStatementArgument() {
103 * Return the parent statement context, or null if this is the root statement.
105 * @return context of parent of statement, or null if this is the root statement.
107 @Nullable StmtContext<?, ?, ?> getParentContext();
110 * Return the parent statement context, forcing a VerifyException if this is the root statement.
112 * @return context of parent of statement
113 * @throws VerifyException if this statement is the root statement
115 default @NonNull StmtContext<?, ?, ?> coerceParentContext() {
116 return verifyNotNull(getParentContext(), "Root context %s does not have a parent", this);
119 boolean isConfiguration();
121 boolean isEnabledSemanticVersioning();
124 * Return a value associated with specified key within a namespace.
126 * @param type Namespace type
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.
135 <K, V, T extends K, N extends IdentifierNamespace<K, V>> @Nullable V getFromNamespace(Class<@NonNull N> type,
138 <K, V, N extends IdentifierNamespace<K, V>> Map<K, V> getAllFromNamespace(Class<N> type);
140 <K, V, N extends IdentifierNamespace<K, V>> Map<K, V> getAllFromCurrentStmtCtxNamespace(Class<N> type);
143 * Returns the model root for this statement.
145 * @return root context of statement
147 @NonNull RootStmtContext<?, ?, ?> getRoot();
150 * Return declared substatements. These are the statements which are explicitly written in the source model.
152 * @return Collection of declared substatements
154 @NonNull Collection<? extends StmtContext<?, ?, ?>> declaredSubstatements();
157 * Return effective substatements. These are the statements which are added as this statement's substatements
158 * complete their effective model phase.
160 * @return Collection of declared substatements
162 @NonNull Collection<? extends StmtContext<?, ?, ?>> effectiveSubstatements();
164 default Iterable<? extends StmtContext<?, ?, ?>> allSubstatements() {
165 return Iterables.concat(declaredSubstatements(), effectiveSubstatements());
168 default Stream<? extends StmtContext<?, ?, ?>> allSubstatementsStream() {
169 return Streams.concat(declaredSubstatements().stream(), effectiveSubstatements().stream());
173 * Builds {@link DeclaredStatement} for statement context.
178 * Builds {@link EffectiveStatement} for statement context.
182 boolean isSupportedToBuildEffective();
184 boolean isSupportedByFeatures();
186 Collection<? extends StmtContext<?, ?, ?>> getEffectOfStatement();
189 * FIXME: YANGTOOLS-784: the next three methods are closely related to the copy process:
190 * - getCopyHistory() 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()
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.
202 * Return the executive summary of the copy process that has produced this context.
204 * @return A simplified summary of the copy process.
206 CopyHistory getCopyHistory();
209 * Return the statement context of the original definition, if this statement is an instantiated copy.
211 * @return Original definition, if this statement was copied.
213 Optional<StmtContext<A, D, E>> getOriginalCtx();
216 * Return the context of the previous copy of this statement -- effectively walking towards the source origin
219 * @return Context of the previous copy of this statement, if this statement has been copied.
221 Optional<StmtContext<A, D, E>> getPreviousCopyCtx();
223 ModelProcessingPhase getCompletedPhase();
226 * Return version of root statement context.
228 * @return version of root statement context
230 @NonNull YangVersion getRootVersion();
233 * An mutable view of an inference context associated with an instance of a statement.
235 * @param <A> Argument type
236 * @param <D> Declared Statement representation
237 * @param <E> Effective Statement representation
239 interface Mutable<A, D extends DeclaredStatement<A>, E extends EffectiveStatement<A, D>>
240 extends StmtContext<A, D, E> {
243 Mutable<?, ?, ?> getParentContext();
246 default Mutable<?, ?, ?> coerceParentContext() {
247 return verifyNotNull(getParentContext(), "Root context %s does not have a parent", this);
251 * Associate a value with a key within a namespace.
253 * @param type Namespace type
256 * @param <K> namespace key type
257 * @param <V> namespace value type
258 * @param <N> namespace type
259 * @param <T> key type
260 * @param <U> value type
261 * @throws NamespaceNotAvailableException when the namespace is not available.
263 <K, V, T extends K, U extends V, N extends IdentifierNamespace<K, V>> void addToNs(Class<@NonNull N> type,
267 RootStmtContext.Mutable<?, ?, ?> getRoot();
270 * Create a child sub-statement, which is a child of this statement, inheriting all attributes from specified
271 * child and recording copy type. Resulting object may only be added as a child of this statement.
273 * @param stmt Statement to be used as a template
274 * @param type Type of copy to record in history
275 * @param targetModule Optional new target module
276 * @return copy of statement considering {@link CopyType} (augment, uses)
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
282 Mutable<?, ?, ?> childCopyOf(StmtContext<?, ?, ?> stmt, CopyType type, @Nullable QNameModule targetModule);
285 * Create a child sub-statement, which is a child of this statement, inheriting all attributes from specified
286 * child and recording copy type. Resulting object may only be added as a child of this statement.
288 * @param stmt Statement to be used as a template
289 * @param type Type of copy to record in history
290 * @return copy of statement considering {@link CopyType} (augment, uses)
292 * @throws IllegalArgumentException if stmt cannot be copied into this statement, for example because it comes
293 * from an alien implementation.
294 * @throws org.opendaylight.yangtools.yang.parser.spi.source.SourceException instance of SourceException
296 default Mutable<?, ?, ?> childCopyOf(final StmtContext<?, ?, ?> stmt, final CopyType type) {
297 return childCopyOf(stmt, type, null);
301 * Create a replica of this statement as a substatement of specified {@code parent}. The replica must not be
302 * modified and acts as a source of {@link EffectiveStatement} from outside of {@code parent}'s subtree.
304 * @param parent Parent of the replica statement
305 * @return replica of this statement
306 * @throws IllegalArgumentException if this statement cannot be replicated into parent, for example because it
307 * comes from an alien implementation.
309 @NonNull Mutable<A, D, E> replicaAsChildOf(Mutable<?, ?, ?> parent);
312 @NonNull Optional<? extends Mutable<?, ?, ?>> copyAsChildOf(Mutable<?, ?, ?> parent, CopyType type,
313 @Nullable QNameModule targetModule);
316 default Collection<? extends StmtContext<?, ?, ?>> declaredSubstatements() {
317 return mutableDeclaredSubstatements();
320 @NonNull Collection<? extends Mutable<?, ?, ?>> mutableDeclaredSubstatements();
323 default Collection<? extends StmtContext<?, ?, ?>> effectiveSubstatements() {
324 return mutableEffectiveSubstatements();
327 @NonNull Collection<? extends Mutable<?, ?, ?>> mutableEffectiveSubstatements();
330 * Create a new inference action to be executed during specified phase. The action cannot be cancelled
331 * and will be executed even if its definition remains incomplete. The specified phase cannot complete until
332 * this action is resolved. If the action cannot be resolved, model processing will fail.
334 * @param phase Target phase in which the action will resolved.
335 * @return A new action builder.
336 * @throws NullPointerException if the specified phase is null
338 @NonNull ModelActionBuilder newInferenceAction(@NonNull ModelProcessingPhase phase);
341 * Adds s statement to namespace map with a key.
344 * {@link StatementNamespace} child that determines namespace to be added to
346 * of type according to namespace class specification
348 * to be added to namespace map
350 <K, KT extends K, N extends StatementNamespace<K, ?, ?>> void addContext(Class<@NonNull N> namespace, KT key,
351 StmtContext<?, ?, ?> stmt);
354 * Set version of root statement context.
357 * of root statement context
359 void setRootVersion(YangVersion version);
362 * Add mutable statement to seal. Each mutable statement must be sealed
363 * as the last step of statement parser processing.
365 * @param mutableStatement
366 * mutable statement which should be sealed
368 void addMutableStmtToSeal(MutableStatement mutableStatement);
371 * Add required module. Based on these dependencies are collected required sources from library sources.
374 * SourceIdentifier of module required by current root
378 * FIXME: this method is used solely during SOURCE_PRE_LINKAGE reactor phase and does not have a corresponding
379 * getter -- which makes it rather strange. At some point this method needs to be deprecated and its
380 * users migrated to use proper global namespace.
382 void addRequiredSource(SourceIdentifier dependency);
384 void addAsEffectOfStatement(StmtContext<?, ?, ?> ctx);
386 void addAsEffectOfStatement(Collection<? extends StmtContext<?, ?, ?>> ctxs);
389 * Set identifier of current root context.
392 * of current root context, must not be null
394 void setRootIdentifier(SourceIdentifier identifier);
396 void setIsSupportedToBuildEffective(boolean isSupportedToBuild);
400 * Search of any child statement context of specified type and return its argument. If such a statement exists, it
401 * is assumed to have the right argument. Users should be careful to use this method for statements which have
402 * cardinality {@code 0..1}, otherwise this method can return any one of the statement's argument.
405 * The default implementation defers to
406 * {@link StmtContextDefaults#findSubstatementArgument(StmtContext, Class)}, subclasses are expected to provide
407 * optimized implementation if possible.
409 * @param <X> Substatement argument type
410 * @param <Z> Substatement effective statement representation
411 * @param type Effective statement representation being look up
412 * @return {@link Optional#empty()} if no statement exists, otherwise the argument value
414 default <X, Z extends EffectiveStatement<X, ?>> @NonNull Optional<X> findSubstatementArgument(
415 final @NonNull Class<Z> type) {
416 return StmtContextDefaults.findSubstatementArgument(this, type);
420 * Check if there is any child statement context of specified type.
423 * The default implementation defers to {@link StmtContextDefaults#hasSubstatement(StmtContext, Class)},
424 * subclasses are expected to provide optimized implementation if possible.
426 * @param type Effective statement representation being look up
427 * @return True if such a child statement exists, false otherwise
429 default boolean hasSubstatement(final @NonNull Class<? extends EffectiveStatement<?, ?>> type) {
430 return StmtContextDefaults.hasSubstatement(this, type);