Fixup collections return implementations
[yangtools.git] / yang / yang-parser-rfc7950 / src / main / java / org / opendaylight / yangtools / yang / parser / rfc7950 / stmt / AbstractDeclaredEffectiveStatement.java
index 02f12e609bf20cdeb2805b6d04100f265e2ee84c..d7dd37dbf4af6274a589f6d95664ea5478255695 100644 (file)
@@ -13,10 +13,10 @@ import static java.util.Objects.requireNonNull;
 import com.google.common.annotations.Beta;
 import com.google.common.collect.ImmutableList;
 import com.google.common.collect.ImmutableMap;
+import java.util.HashMap;
 import java.util.Map;
 import java.util.Optional;
 import org.eclipse.jdt.annotation.NonNull;
-import org.eclipse.jdt.annotation.Nullable;
 import org.opendaylight.yangtools.yang.common.QName;
 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
@@ -28,7 +28,9 @@ import org.opendaylight.yangtools.yang.model.api.stmt.DataTreeAwareEffectiveStat
 import org.opendaylight.yangtools.yang.model.api.stmt.DataTreeEffectiveStatement;
 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeAwareEffectiveStatement;
 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeEffectiveStatement;
+import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStatementMixins.DataNodeContainerMixin;
 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
+import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
 import org.opendaylight.yangtools.yang.parser.spi.source.StatementSourceReference;
 
 /**
@@ -131,6 +133,46 @@ public abstract class AbstractDeclaredEffectiveStatement<A, D extends DeclaredSt
         }
     }
 
+    /**
+     * Utility class for implementing DataNodeContainer-type statements.
+     */
+    public abstract static class DefaultDataNodeContainer<A, D extends DeclaredStatement<A>> extends Default<A, D>
+            implements DataNodeContainerMixin<A, D> {
+        private final @NonNull ImmutableMap<QName, DataSchemaNode> dataChildren;
+        private final @NonNull Object substatements;
+
+        protected DefaultDataNodeContainer(final D declared, final StatementSourceReference ref,
+                final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
+            super(declared);
+            this.substatements = maskList(substatements);
+
+            // Note: we do not leak this map, so iteration order does not matter
+            final Map<QName, DataSchemaNode> tmp = new HashMap<>();
+
+            for (EffectiveStatement<?, ?> stmt : effectiveSubstatements()) {
+                if (stmt instanceof DataSchemaNode) {
+                    final DataSchemaNode node = (DataSchemaNode) stmt;
+                    final QName id = node.getQName();
+                    final DataSchemaNode prev = tmp.put(id, node);
+                    SourceException.throwIf(prev != null, ref,
+                            "Cannot add child with name %s, a conflicting child already exists", id);
+                }
+            }
+
+            dataChildren = ImmutableMap.copyOf(tmp);
+        }
+
+        @Override
+        public final ImmutableList<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
+            return unmaskList(substatements);
+        }
+
+        @Override
+        public final Optional<DataSchemaNode> findDataChildByName(final QName name) {
+            return Optional.ofNullable(dataChildren.get(requireNonNull(name)));
+        }
+    }
+
     /**
      * An extra building block on top of {@link Default}, which is wiring {@link #argument()} to the declared statement.
      * This is mostly useful for arguments that are not subject to inference transformation -- for example Strings in
@@ -162,11 +204,48 @@ public abstract class AbstractDeclaredEffectiveStatement<A, D extends DeclaredSt
         }
 
         @Override
-        public final @Nullable A argument() {
+        public final A argument() {
             return getDeclared().argument();
         }
     }
 
+    /**
+     * A building block on top of {@link Default}, which adds an explicit argument value, which is not related to the
+     * context. This is mostly useful when the effective argument value reflects additional statements and similar.
+     *
+     * @param <A> Argument type ({@link Void} if statement does not have argument.)
+     * @param <D> Class representing declared version of this statement.
+     */
+    public abstract static class DefaultWithArgument<A, D extends DeclaredStatement<A>> extends Default<A, D> {
+        public abstract static class WithSubstatements<A, D extends DeclaredStatement<A>>
+                extends DefaultWithArgument<A, D> {
+            private final @NonNull Object substatements;
+
+            protected WithSubstatements(final D declared, final A argument,
+                    final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
+                super(declared, argument);
+                this.substatements = maskList(substatements);
+            }
+
+            @Override
+            public final ImmutableList<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
+                return unmaskList(substatements);
+            }
+        }
+
+        private final A argument;
+
+        protected DefaultWithArgument(final D declared, final A argument) {
+            super(declared);
+            this.argument = argument;
+        }
+
+        @Override
+        public final A argument() {
+            return argument;
+        }
+    }
+
     /**
      * Stateful version of {@link WithSchemaTree}. Schema tree namespace is eagerly instantiated (and checked).
      *
@@ -198,7 +277,7 @@ public abstract class AbstractDeclaredEffectiveStatement<A, D extends DeclaredSt
         protected DefaultWithSchemaTree(final D declared, final StmtContext<?, ?, ?> ctx,
                 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
             this.declared = requireNonNull(declared);
-            this.schemaTree = ImmutableMap.copyOf(AbstractSchemaEffectiveDocumentedNode.createSchemaTreeNamespace(
+            this.schemaTree = ImmutableMap.copyOf(createSchemaTreeNamespace(
                 ctx.getStatementSourceReference(), substatements));
         }
 
@@ -247,11 +326,9 @@ public abstract class AbstractDeclaredEffectiveStatement<A, D extends DeclaredSt
                 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
             this.declared = requireNonNull(declared);
             final StatementSourceReference ref = ctx.getStatementSourceReference();
-            final Map<QName, SchemaTreeEffectiveStatement<?>> schema =
-                    AbstractSchemaEffectiveDocumentedNode.createSchemaTreeNamespace(ref, substatements);
+            final Map<QName, SchemaTreeEffectiveStatement<?>> schema = createSchemaTreeNamespace(ref, substatements);
             this.schemaTree = ImmutableMap.copyOf(schema);
-            this.dataTree = AbstractSchemaEffectiveDocumentedNode.createDataTreeNamespace(ref, schema.values(),
-                schemaTree);
+            this.dataTree = createDataTreeNamespace(ref, schema.values(), schemaTree);
         }
 
         @Override