Allow derived context to be reused

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

diff --git a/yang/yang-parser-spi/src/main/java/org/opendaylight/yangtools/yang/parser/spi/meta/StatementFactory.java b/yang/yang-parser-spi/src/main/java/org/opendaylight/yangtools/yang/parser/spi/meta/StatementFactory.java
index f929529c63277cefa8ac569d23af7d34606800e4..279e9336965ab8d857723cbdae97557666efaacf 100644 (file)
--- a/yang/yang-parser-spi/src/main/java/org/opendaylight/yangtools/yang/parser/spi/meta/StatementFactory.java
+++ b/yang/yang-parser-spi/src/main/java/org/opendaylight/yangtools/yang/parser/spi/meta/StatementFactory.java
@@ -7,10 +7,12 @@
  */
 package org.opendaylight.yangtools.yang.parser.spi.meta;
 
+import java.util.Collection;
 import java.util.stream.Stream;
 import org.eclipse.jdt.annotation.NonNull;
 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
+import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
 
 /**
  * An entity capable of creating {@link DeclaredStatement} and {@link EffectiveStatement} instances for a particular
@@ -35,7 +37,36 @@ public interface StatementFactory<A, D extends DeclaredStatement<A>, E extends E
      * @param stmt Effective capture of this statement's significant state
      * @return An effective statement instance
      */
-    @NonNull E createEffective(EffectiveStmtCtx.@NonNull Current<A, D> stmt,
+    @NonNull E createEffective(@NonNull Current<A, D> stmt,
         Stream<? extends StmtContext<?, ?, ?>> declaredSubstatements,
         Stream<? extends StmtContext<?, ?, ?>> effectiveSubstatements);
+
+    /**
+     * Create a {@link EffectiveStatement} copy of provided original for specified context.
+     *
+     * @param stmt Effective capture of this statement's significant state
+     * @param original Original effective statement
+     * @return An effective statement instance
+     * @throws NullPointerException if any argument is null
+     */
+    @NonNull E copyEffective(@NonNull Current<A, D> stmt, @NonNull E original);
+
+    /**
+     * Determine reactor copy behaviour of a statement instance. Implementations classes are required to determine
+     * their operations with regard to their statements being replicated into different contexts -- potentially sharing
+     * instantiations.
+     *
+     * <p>
+     * Implementations are examine {@code copy} as to whether it would result in the same semantics as {@code current}
+     * does, provided that {@code current}'s {@code substatements} are properly propagated.
+     *
+     * @param copy Copy of current effective context
+     * @param current Current effective context
+     * @param substatements Current effective substatements
+     * @return True if the differences between {@code copy} and {@code current} do not affect this statement's effective
+     *         semantics.
+     * @throws NullPointerException if any argument is null
+     */
+    boolean canReuseCurrent(@NonNull Current<A, D> copy, @NonNull Current<A, D> current,
+        @NonNull Collection<? extends EffectiveStatement<?, ?>> substatements);
 }