Clarify StatementFactory.createEffective()

[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 239644a158742adfcdc43a6bf0c10fdf10067c67..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
@@ -35,22 +35,24 @@ public interface StatementFactory<A, D extends DeclaredStatement<A>, E extends E
      * Create a {@link EffectiveStatement} for specified context.
      *
      * @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
      */
-    @NonNull E createEffective(EffectiveStmtCtx.@NonNull Current<A, D> stmt,
+    // FIXME: we really want a single coherent 'effectiveSubstatements' stream
+    @NonNull E createEffective(@NonNull Current<A, D> stmt,
         Stream<? extends StmtContext<?, ?, ?>> declaredSubstatements,
-        Stream<? extends StmtContext<?, ?, ?>> effectiveSubstatements);
+        Stream<? extends StmtContext<?, ?, ?>> inferredSubstatements);
 
     /**
-     * Create a {@link EffectiveStatement} for specified context and substatements.
+     * Create a {@link EffectiveStatement} copy of provided original for specified context.
      *
      * @param stmt Effective capture of this statement's significant state
-     * @param substatements Current effective substatements
+     * @param original Original effective statement
      * @return An effective statement instance
      * @throws NullPointerException if any argument is null
      */
-    @NonNull E createEffective(EffectiveStmtCtx.@NonNull Current<A, D> stmt,
-        @NonNull Collection<? extends EffectiveStatement<?, ?>> substatements);
+    @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