*/
package org.opendaylight.yangtools.yang.parser.spi.meta;
-import java.util.List;
-import java.util.Map;
-import org.opendaylight.yangtools.yang.common.QNameModule;
-import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
-import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase;
+import com.google.common.base.Optional;
import java.util.Collection;
+import java.util.Map;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
+import org.opendaylight.yangtools.yang.common.QNameModule;
+import org.opendaylight.yangtools.yang.common.YangVersion;
+import org.opendaylight.yangtools.yang.model.api.ModuleIdentifier;
+import org.opendaylight.yangtools.yang.model.api.SchemaPath;
import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
import org.opendaylight.yangtools.yang.model.api.meta.IdentifierNamespace;
import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
import org.opendaylight.yangtools.yang.model.api.meta.StatementSource;
import org.opendaylight.yangtools.yang.parser.spi.source.StatementSourceReference;
+import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase;
public interface StmtContext<A, D extends DeclaredStatement<A>, E extends EffectiveStatement<A, D>> {
@Nonnull
StatementDefinition getPublicDefinition();
+ /**
+ * Return the parent statement context, or null if this is the root statement.
+ *
+ * @return context of parent of statement, or null if this is the root statement.
+ */
@Nullable
StmtContext<?, ?, ?> getParentContext();
+ /**
+ * @return raw statement argument string
+ */
@Nullable
String rawStatementArgument();
@Nullable
A getStatementArgument();
- @Nullable
- List<Object> getArgumentsFromRoot();
+ /**
+ * Return the {@link SchemaPath} of this statement. Not all statements have a SchemaPath, in which case
+ * {@link Optional#absent()} is returned.
+ *
+ * @return Optional SchemaPath
+ */
+ @Nonnull Optional<SchemaPath> getSchemaPath();
- List<StmtContext<?,?,?>> getStmtContextsFromRoot();
+ boolean isConfiguration();
+
+ /**
+ * Checks whether this statement is placed within a 'yang-data' extension statement.
+ * Some YANG statements are constrained when used within a 'yang-data' statement.
+ * See the following link for more information - https://tools.ietf.org/html/rfc8040#section-8
+ *
+ * @return true if it is placed within a 'yang-data' extension statement, otherwise false
+ */
+ boolean isInYangDataExtensionBody();
+
+ boolean isEnabledSemanticVersioning();
@Nonnull
<K, V, KT extends K, N extends IdentifierNamespace<K, V>> V getFromNamespace(
@Nonnull
StmtContext<?, ?, ?> getRoot();
+ /**
+ * Return declared substatements. These are the statements which are explicitly written in the source model.
+ *
+ * @return Collection of declared substatements
+ */
@Nonnull
- Collection<StatementContextBase<?, ?, ?>> declaredSubstatements();
-
- Collection<StatementContextBase<?, ?, ?>> effectiveSubstatements();
-
- Collection<StatementContextBase<?, ?, ?>> substatements();
+ Collection<? extends StmtContext<?, ?, ?>> declaredSubstatements();
+
+ /**
+ * Return effective substatements. These are the statements which are added as this statement's substatements
+ * complete their effective model phase.
+ *
+ * @return Collection of declared substatements
+ */
+ @Nonnull
+ Collection<? extends StmtContext<?, ?, ?>> effectiveSubstatements();
+ /**
+ * Builds {@link DeclaredStatement} for statement context.
+ */
D buildDeclared();
+ /**
+ * Builds {@link EffectiveStatement} for statement context
+ */
E buildEffective();
boolean isSupportedToBuildEffective();
- void setIsSupportedToBuildEffective(boolean isSupportedToBuild);
-
- Collection<StatementContextBase<?, ?, ?>> getEffectOfStatement();
+ Collection<? extends StmtContext<?, ?, ?>> getEffectOfStatement();
- void addAsEffectOfStatement(StatementContextBase<?, ?, ?> ctx);
+ /**
+ * @return copy of this considering {@link CopyType} (augment, uses)
+ *
+ * @throws org.opendaylight.yangtools.yang.parser.spi.source.SourceException instance of SourceException
+ */
+ Mutable<A, D, E> createCopy(StatementContextBase<?, ?, ?> newParent, CopyType typeOfCopy);
- StatementContextBase<?, ?, ?> createCopy(
- StatementContextBase<?, ?, ?> newParent, TypeOfCopy typeOfCopy)
- throws SourceException;
+ /**
+ * @return copy of this considering {@link CopyType} (augment, uses)
+ *
+ * @throws org.opendaylight.yangtools.yang.parser.spi.source.SourceException instance of SourceException
+ */
+ Mutable<A, D, E> createCopy(QNameModule newQNameModule, StatementContextBase<?, ?, ?> newParent,
+ CopyType typeOfCopy);
- StatementContextBase<?, ?, ?> createCopy(QNameModule newQNameModule,
- StatementContextBase<?, ?, ?> newParent, TypeOfCopy typeOfCopy)
- throws SourceException;
+ CopyHistory getCopyHistory();
- enum TypeOfCopy {
- ORIGINAL, ADDED_BY_USES, ADDED_BY_AUGMENTATION, ADDED_BY_USES_AUGMENTATION
- }
-
- List<TypeOfCopy> getCopyHistory();
-
- void addAllToCopyHistory(List<TypeOfCopy> typeOfCopyList);
-
- void addToCopyHistory(TypeOfCopy typeOfCopy);
-
- StatementContextBase<?, ?, ?> getOriginalCtx();
-
- void setOriginalCtx(StatementContextBase<?, ?, ?> originalCtx);
-
- boolean isRootContext();
+ boolean isSupportedByFeatures();
- void setOrder(int order);
+ StmtContext<?, ?, ?> getOriginalCtx();
int getOrder();
- void setCompletedPhase(ModelProcessingPhase completedPhase);
-
ModelProcessingPhase getCompletedPhase();
+ /**
+ * Return version of root statement context.
+ *
+ * @return version of root statement context
+ */
+ @Nonnull YangVersion getRootVersion();
+
interface Mutable<A, D extends DeclaredStatement<A>, E extends EffectiveStatement<A, D>>
extends StmtContext<A, D, E> {
@Override
- StmtContext.Mutable<?, ?, ?> getParentContext();
+ Mutable<?, ?, ?> getParentContext();
- <K, V, KT extends K, VT extends V, N extends IdentifierNamespace<K, V>> void addToNs(
- Class<N> type, KT key, VT value)
- throws NamespaceNotAvailableException;
+ <K, V, KT extends K, VT extends V, N extends IdentifierNamespace<K, V>> void addToNs(Class<N> type, KT key,
+ VT value) throws NamespaceNotAvailableException;
+ @Nonnull
@Override
- StmtContext.Mutable<?, ?, ?> getRoot();
-
- ModelActionBuilder newInferenceAction(ModelProcessingPhase phase);
-
- <K, KT extends K, N extends StatementNamespace<K, ?, ?>> void addContext(
- Class<N> namespace, KT key, StmtContext<?, ?, ?> stmt);
-
+ Mutable<?, ?, ?> getRoot();
+
+ @Nonnull
+ Collection<? extends Mutable<?, ?, ?>> mutableDeclaredSubstatements();
+
+ @Nonnull
+ Collection<? extends Mutable<?, ?, ?>> mutableEffectiveSubstatements();
+
+ /**
+ * Create a new inference action to be executed during specified phase. The action cannot be cancelled
+ * and will be executed even if its definition remains incomplete.
+ *
+ * @param phase Target phase in which the action will resolved.
+ * @return A new action builder.
+ * @throws NullPointerException if the specified phase is null
+ */
+ @Nonnull ModelActionBuilder newInferenceAction(@Nonnull ModelProcessingPhase phase);
+
+ /**
+ * adds statement to namespace map with the key
+ *
+ * @param namespace
+ * {@link StatementNamespace} child that determines namespace to be added to
+ * @param key
+ * of type according to namespace class specification
+ * @param stmt
+ * to be added to namespace map
+ */
+ <K, KT extends K, N extends StatementNamespace<K, ?, ?>> void addContext(Class<N> namespace, KT key,
+ StmtContext<?, ?, ?> stmt);
+
+ /**
+ * Set version of root statement context.
+ *
+ * @param version
+ * of root statement context
+ */
+ void setRootVersion(YangVersion version);
+
+ /**
+ * Add mutable statement to seal. Each mutable statement must be sealed
+ * as the last step of statement parser processing.
+ *
+ * @param mutableStatement
+ * mutable statement which should be sealed
+ */
+ void addMutableStmtToSeal(MutableStatement mutableStatement);
+
+ /**
+ * Add required module. Based on these dependencies are collected
+ * required sources from library sources.
+ *
+ * @param dependency
+ * ModuleIdentifier of module required by current root
+ * context
+ */
+ void addRequiredModule(ModuleIdentifier dependency);
+
+ void addAsEffectOfStatement(StmtContext<?, ?, ?> ctx);
+
+ void addAsEffectOfStatement(Collection<? extends StmtContext<?, ?, ?>> ctxs);
+
+ /**
+ * Set identifier of current root context.
+ *
+ * @param identifier
+ * of current root context
+ */
+ void setRootIdentifier(ModuleIdentifier identifier);
+
+ void setIsSupportedToBuildEffective(boolean isSupportedToBuild);
+
+ void setOrder(int order);
+
+ // FIXME: this seems to be unused, but looks useful.
+ void setCompletedPhase(ModelProcessingPhase completedPhase);
}
-
}
Code Review / yangtools.git / blobdiff