Un-deprecate CopyableNode, AddedByUsesAware

[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 458a188ae18ac67852cb692666b09b7bc7cd6a59..777227f45c33939ff0efe579ab4b5bb8005ece0a 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,21 @@
  */
 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
+ * type. This interface is usually realized as an implementation-specific combination with {@link StatementSupport}.
+ *
+ * @param <A> Argument type
+ * @param <D> Declared Statement representation
+ * @param <E> Effective Statement representation
+ */
 public interface StatementFactory<A, D extends DeclaredStatement<A>, E extends EffectiveStatement<A, D>> {
     /**
      * Create a {@link DeclaredStatement} for specified context.
@@ -23,8 +34,42 @@ public interface StatementFactory<A, D extends DeclaredStatement<A>, E extends E
     /**
      * Create a {@link EffectiveStatement} for specified context.
      *
-     * @param ctx Statement context
-     * @return An effective statement instance.
+     * @param stmt Effective capture of this statement's significant state
+     * @param declaredSubstatements effectively-visible declared substatements
+     * @param inferredSubstatements effectively-visible inferred substatements
+     * @return An effective statement instance
+     */
+    // FIXME: we really want a single coherent 'effectiveSubstatements' stream
+    @NonNull E createEffective(@NonNull Current<A, D> stmt,
+        Stream<? extends StmtContext<?, ?, ?>> declaredSubstatements,
+        Stream<? extends StmtContext<?, ?, ?>> inferredSubstatements);
+
+    /**
+     * 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
      */
-    @NonNull E createEffective(@NonNull StmtContext<A, D, E> ctx);
+    boolean canReuseCurrent(@NonNull Current<A, D> copy, @NonNull Current<A, D> current,
+        @NonNull Collection<? extends EffectiveStatement<?, ?>> substatements);
 }