BUG-6522: create a specialized CopyHistory object

[yangtools.git] / yang / yang-parser-impl / src / main / java / org / opendaylight / yangtools / yang / parser / spi / meta / StmtContext.java

diff --git a/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/spi/meta/StmtContext.java b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/spi/meta/StmtContext.java
index 124d6bf9e18772f52b02e1ea3ba133e5b60c904d..b49363f991551e002685471d47371bd35ba53953 100644 (file)
--- a/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/spi/meta/StmtContext.java
+++ b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/spi/meta/StmtContext.java
@@ -7,58 +7,136 @@
  */
 package org.opendaylight.yangtools.yang.parser.spi.meta;
 
+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.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.SourceException;
 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>> {
 
-public interface StmtContext<A,D extends DeclaredStatement<A>, E extends EffectiveStatement<A, D>> {
+    @Nonnull
+    StatementSource getStatementSource();
 
-    @Nonnull StatementSource getStatementSource();
+    @Nonnull
+    StatementSourceReference getStatementSourceReference();
 
-    @Nonnull StatementSourceReference getStatementSourceReference();
+    @Nonnull
+    StatementDefinition getPublicDefinition();
 
-    @Nonnull StatementDefinition getPublicDefinition();
+    @Nullable
+    StmtContext<?, ?, ?> getParentContext();
 
-    @Nullable StmtContext<?,?,?> getParentContext();
+    @Nullable
+    String rawStatementArgument();
 
-    @Nullable String rawStatementArgument();
+    @Nullable
+    A getStatementArgument();
 
-    @Nullable A getStatementArgument();
+    /**
+     * 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();
 
-    @Nonnull <K,VT, V extends VT,N extends IdentifierNamespace<K, V>> VT getFromNamespace(Class<N> type, K key) throws NamespaceNotAvailableException;
+    boolean isConfiguration();
 
-    @Nonnull StmtContext<?,?,?> getRoot();
+    boolean isEnabledSemanticVersioning();
 
-    @Nonnull Collection<? extends StmtContext<?,?,?>> declaredSubstatements();
+    @Nonnull
+    <K, V, KT extends K, N extends IdentifierNamespace<K, V>> V getFromNamespace(
+            Class<N> type, KT key) throws NamespaceNotAvailableException;
+
+    <K, V, N extends IdentifierNamespace<K, V>> Map<K, V> getAllFromNamespace(
+            Class<N> type);
+
+    <K, V, N extends IdentifierNamespace<K, V>> Map<K, V> getAllFromCurrentStmtCtxNamespace(Class<N> type);
+
+    @Nonnull
+    StmtContext<?, ?, ?> getRoot();
+
+    @Nonnull
+    Collection<StatementContextBase<?, ?, ?>> declaredSubstatements();
+
+    Collection<StatementContextBase<?, ?, ?>> effectiveSubstatements();
+
+    Collection<StatementContextBase<?, ?, ?>> substatements();
 
     D buildDeclared();
 
     E buildEffective();
 
-    interface Mutable<A,D extends DeclaredStatement<A>,E extends EffectiveStatement<A, D>> extends StmtContext<A,D,E> {
+    boolean isSupportedToBuildEffective();
+
+    void setIsSupportedToBuildEffective(boolean isSupportedToBuild);
+
+    Collection<StatementContextBase<?, ?, ?>> getEffectOfStatement();
+
+    void addAsEffectOfStatement(StatementContextBase<?, ?, ?> ctx);
+
+    StatementContextBase<?, ?, ?> createCopy(
+            StatementContextBase<?, ?, ?> newParent, CopyType typeOfCopy)
+            throws SourceException;
+
+    StatementContextBase<?, ?, ?> createCopy(QNameModule newQNameModule,
+            StatementContextBase<?, ?, ?> newParent, CopyType typeOfCopy)
+            throws SourceException;
+
+    CopyHistory getCopyHistory();
+
+    enum SupportedByFeatures {
+        UNDEFINED, SUPPORTED, NOT_SUPPORTED
+    }
+
+    SupportedByFeatures getSupportedByFeatures();
+
+    void appendCopyHistory(CopyType typeOfCopy, CopyHistory toAppend);
+
+    StatementContextBase<?, ?, ?> getOriginalCtx();
+
+    void setOriginalCtx(StatementContextBase<?, ?, ?> originalCtx);
+
+    boolean isRootContext();
+
+    void setOrder(int order);
+
+    int getOrder();
+
+    void setCompletedPhase(ModelProcessingPhase completedPhase);
+
+    ModelProcessingPhase getCompletedPhase();
+
+    interface Mutable<A, D extends DeclaredStatement<A>, E extends EffectiveStatement<A, D>>
+            extends StmtContext<A, D, E> {
 
         @Override
-        StmtContext.Mutable<?,?,?> getParentContext();
+        StmtContext.Mutable<?, ?, ?> getParentContext();
 
-        <K,V,VT extends V,N extends IdentifierNamespace<K, V>> void addToNs(Class<N> type, K 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;
 
         @Override
-        StmtContext.Mutable<?,?,?> getRoot();
+        StmtContext.Mutable<?, ?, ?> getRoot();
 
         ModelActionBuilder newInferenceAction(ModelProcessingPhase phase);
 
-        <K,KT extends K, N extends StatementNamespace<K, ?, ?>> void addContext(Class<N> namepsace, KT key,
-                StmtContext<?, ?, ?> stmt);
+        <K, KT extends K, N extends StatementNamespace<K, ?, ?>> void addContext(
+                Class<N> namespace, KT key, StmtContext<?, ?, ?> stmt);
 
+        void setSupportedByFeatures(boolean isSupported);
     }
 
-
-
 }