BUG-865: deprecate pre-Beryllium parser elements
[yangtools.git] / yang / yang-parser-impl / src / main / java / org / opendaylight / yangtools / yang / parser / builder / impl / GroupingBuilderImpl.java
index 71a4862aeef7d69a44d35218967ddef1a78c453d..191e234e65df8c8ec970e0741b2daeba7973fc86 100644 (file)
  */
 package org.opendaylight.yangtools.yang.parser.builder.impl;
 
+import com.google.common.base.Preconditions;
+import com.google.common.collect.ImmutableList;
 import java.util.ArrayList;
-import java.util.Collections;
 import java.util.HashSet;
 import java.util.List;
-import java.util.Map;
+import java.util.Objects;
 import java.util.Set;
-import java.util.TreeMap;
-import java.util.TreeSet;
-
 import org.opendaylight.yangtools.yang.common.QName;
-import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
-import org.opendaylight.yangtools.yang.model.api.Status;
-import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
-import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
-import org.opendaylight.yangtools.yang.model.api.UsesNode;
-import org.opendaylight.yangtools.yang.parser.builder.api.AbstractDataNodeContainerBuilder;
+import org.opendaylight.yangtools.yang.parser.builder.api.Builder;
 import org.opendaylight.yangtools.yang.parser.builder.api.DataSchemaNodeBuilder;
 import org.opendaylight.yangtools.yang.parser.builder.api.GroupingBuilder;
 import org.opendaylight.yangtools.yang.parser.builder.api.TypeDefinitionBuilder;
-import org.opendaylight.yangtools.yang.parser.builder.api.UsesNodeBuilder;
-import org.opendaylight.yangtools.yang.parser.util.Comparators;
-import org.opendaylight.yangtools.yang.parser.util.YangParseException;
+import org.opendaylight.yangtools.yang.parser.builder.api.UnknownSchemaNodeBuilder;
+import org.opendaylight.yangtools.yang.parser.builder.util.AbstractDocumentedDataNodeContainerBuilder;
 
-public final class GroupingBuilderImpl extends AbstractDataNodeContainerBuilder implements GroupingBuilder {
-    private boolean isBuilt;
-    private final GroupingDefinitionImpl instance;
+/**
+ * @deprecated Pre-Beryllium implementation, scheduled for removal.
+ */
+@Deprecated
+public final class GroupingBuilderImpl extends AbstractDocumentedDataNodeContainerBuilder implements GroupingBuilder {
+    private GroupingDefinitionImpl instance;
+    // SchemaNode args
     private SchemaPath schemaPath;
-    private String description;
-    private String reference;
-    private Status status = Status.CURRENT;
+    // DataSchemaNode args
     private boolean addedByUses;
 
-    private Set<TypeDefinition<?>> typedefs;
-    private final Set<TypeDefinitionBuilder> addedTypedefs = new HashSet<TypeDefinitionBuilder>();
-
-    private Set<UsesNode> usesNodes;
-    private final Set<UsesNodeBuilder> addedUsesNodes = new HashSet<UsesNodeBuilder>();
-
-    public GroupingBuilderImpl(final String moduleName, final int line, final QName qname) {
+    public GroupingBuilderImpl(final String moduleName, final int line, final QName qname, final SchemaPath path) {
         super(moduleName, line, qname);
-        instance = new GroupingDefinitionImpl(qname);
+        this.schemaPath = Preconditions.checkNotNull(path, "Schema Path must not be null");
     }
 
-    public GroupingBuilderImpl(GroupingBuilder builder, QName qname) {
-        super(builder.getModuleName(), builder.getLine(), qname);
-        parent = builder.getParent();
-        instance = new GroupingDefinitionImpl(qname);
-        schemaPath = builder.getPath();
-        description = builder.getDescription();
-        reference = builder.getReference();
-        status = builder.getStatus();
-        addedByUses = builder.isAddedByUses();
-        childNodes = builder.getChildNodes();
-        addedChildNodes.addAll(builder.getChildNodeBuilders());
-        groupings = builder.getGroupings();
-        addedGroupings.addAll(builder.getGroupingBuilders());
-        addedUsesNodes.addAll(builder.getUses());
-        addedUnknownNodes.addAll(builder.getUnknownNodeBuilders());
+    public GroupingBuilderImpl(final String moduleName, final int line, final QName qname, final SchemaPath path,
+            final GroupingDefinition base) {
+        super(moduleName, line, base.getQName(), Preconditions.checkNotNull(path, "Schema Path must not be null"), base);
+        schemaPath = path;
+        addedByUses = base.isAddedByUses();
+        addedUnknownNodes.addAll(BuilderUtils.wrapUnknownNodes(moduleName, line, base.getUnknownSchemaNodes(), path,
+                qname));
     }
 
     @Override
     public GroupingDefinition build() {
-        if (!isBuilt) {
-            // process uses
-            for(UsesNodeBuilder use : addedUsesNodes) {
-                addedChildNodes.addAll(use.getTargetChildren());
-                addedGroupings.addAll(use.getTargetGroupings());
-                addedTypedefs.addAll(use.getTargetTypedefs());
-                addedUnknownNodes.addAll(use.getTargetUnknownNodes());
-            }
-
-            instance.setPath(schemaPath);
-            instance.setDescription(description);
-            instance.setReference(reference);
-            instance.setStatus(status);
-            instance.setAddedByUses(addedByUses);
-
-            // CHILD NODES
-            final Map<QName, DataSchemaNode> childs = new TreeMap<QName, DataSchemaNode>(Comparators.QNAME_COMP);
-            if (childNodes == null || childNodes.isEmpty()) {
-                for (DataSchemaNodeBuilder node : addedChildNodes) {
-                    childs.put(node.getQName(), node.build());
-                }
-            } else {
-                for (DataSchemaNode node : childNodes) {
-                    childs.put(node.getQName(), node);
-                }
-            }
-            instance.setChildNodes(childs);
-
-            // GROUPINGS
-            if (groupings == null) {
-                groupings = new TreeSet<GroupingDefinition>(Comparators.SCHEMA_NODE_COMP);
-                for (GroupingBuilder builder : addedGroupings) {
-                    groupings.add(builder.build());
-                }
-            }
-            instance.setGroupings(groupings);
-
-            // TYPEDEFS
-            if (typedefs == null) {
-                typedefs = new TreeSet<TypeDefinition<?>>(Comparators.SCHEMA_NODE_COMP);
-                for (TypeDefinitionBuilder entry : addedTypedefs) {
-                    typedefs.add(entry.build());
-                }
-            }
-            instance.setTypeDefinitions(typedefs);
-
-            // USES
-            if (usesNodes == null) {
-                usesNodes = new HashSet<UsesNode>();
-                for (UsesNodeBuilder builder : addedUsesNodes) {
-                    usesNodes.add(builder.build());
-                }
-            }
-            instance.setUses(usesNodes);
-
-            // UNKNOWN NODES
-            if (unknownNodes == null) {
-                unknownNodes = new ArrayList<UnknownSchemaNode>();
-                for (UnknownSchemaNodeBuilder b : addedUnknownNodes) {
-                    unknownNodes.add(b.build());
-                }
-                Collections.sort(unknownNodes, Comparators.SCHEMA_NODE_COMP);
-            }
-            instance.setUnknownSchemaNodes(unknownNodes);
+        if (instance != null) {
+            return instance;
+        }
+        buildChildren();
+        instance = new GroupingDefinitionImpl(qname, schemaPath, this);
+        instance.addedByUses = addedByUses;
 
-            isBuilt = true;
+        // UNKNOWN NODES
+        for (UnknownSchemaNodeBuilder b : addedUnknownNodes) {
+            unknownNodes.add(b.build());
         }
+        instance.unknownNodes = ImmutableList.copyOf(unknownNodes);
 
         return instance;
     }
 
-
-    @Override
-    public Set<TypeDefinitionBuilder> getTypeDefinitionBuilders() {
-        return addedTypedefs;
-    }
-
     @Override
-    public void addTypedef(final TypeDefinitionBuilder type) {
-        String typeName = type.getQName().getLocalName();
-        for (TypeDefinitionBuilder addedTypedef : addedTypedefs) {
-            throw new YangParseException(moduleName, type.getLine(), "Can not add typedef '" + typeName
-                    + "': typedef with same name already declared at line " + addedTypedef.getLine());
+    public List<DataSchemaNodeBuilder> instantiateChildNodes(final Builder newParent) {
+        final List<DataSchemaNodeBuilder> nodes = new ArrayList<>();
+        for (DataSchemaNodeBuilder node : getChildNodeBuilders()) {
+            DataSchemaNodeBuilder copy = CopyUtils.copy(node, newParent, true);
+            BuilderUtils.setNodeAddedByUses(copy);
+            nodes.add(copy);
         }
-        addedTypedefs.add(type);
-    }
-
-    public void setTypedefs(final Set<TypeDefinition<?>> typedefs) {
-        this.typedefs = typedefs;
-    }
-
-    @Override
-    public SchemaPath getPath() {
-        return schemaPath;
-    }
-
-    @Override
-    public void setPath(SchemaPath schemaPath) {
-        this.schemaPath = schemaPath;
-    }
-
-    @Override
-    public String getDescription() {
-        return description;
+        return nodes;
     }
 
     @Override
-    public void setDescription(final String description) {
-        this.description = description;
+    public Set<TypeDefinitionBuilder> instantiateTypedefs(final Builder newParent) {
+        final Set<TypeDefinitionBuilder> nodes = new HashSet<>();
+        for (TypeDefinitionBuilder node : getTypeDefinitionBuilders()) {
+            TypeDefinitionBuilder copy = CopyUtils.copy(node, newParent, true);
+            nodes.add(copy);
+        }
+        return nodes;
     }
 
     @Override
-    public String getReference() {
-        return reference;
+    public Set<GroupingBuilder> instantiateGroupings(final Builder newParent) {
+        final Set<GroupingBuilder> nodes = new HashSet<>();
+        for (GroupingBuilder node : getGroupingBuilders()) {
+            GroupingBuilder copy = CopyUtils.copy(node, newParent, true);
+            copy.setAddedByUses(true);
+            for (DataSchemaNodeBuilder childNode : copy.getChildNodeBuilders()) {
+                BuilderUtils.setNodeAddedByUses(childNode);
+            }
+            nodes.add(copy);
+        }
+        return nodes;
     }
 
     @Override
-    public void setReference(final String reference) {
-        this.reference = reference;
+    public Set<UnknownSchemaNodeBuilder> instantiateUnknownNodes(final Builder newParent) {
+        final Set<UnknownSchemaNodeBuilder> nodes = new HashSet<>();
+        for (UnknownSchemaNodeBuilder node : addedUnknownNodes) {
+            UnknownSchemaNodeBuilderImpl copy = CopyUtils.copy(node, newParent, true);
+            copy.setAddedByUses(true);
+            nodes.add(copy);
+        }
+        return nodes;
     }
 
     @Override
-    public Status getStatus() {
-        return status;
+    public SchemaPath getPath() {
+        return schemaPath;
     }
 
     @Override
-    public void setStatus(final Status status) {
-        this.status = status;
+    public void setPath(final SchemaPath path) {
+        this.schemaPath = path;
     }
 
     @Override
@@ -213,203 +134,54 @@ public final class GroupingBuilderImpl extends AbstractDataNodeContainerBuilder
     }
 
     @Override
-    public Set<UsesNodeBuilder> getUses() {
-        return addedUsesNodes;
+    public String toString() {
+        return "grouping " + qname.getLocalName();
     }
 
     @Override
-    public void addUsesNode(final UsesNodeBuilder usesBuilder) {
-        addedUsesNodes.add(usesBuilder);
-    }
-
-    public void setUsesnodes(final Set<UsesNode> usesNodes) {
-        this.usesNodes = usesNodes;
+    public int hashCode() {
+        final int prime = 31;
+        int result = 1;
+        result = prime * result + Objects.hashCode(getParent());
+        result = prime * result + Objects.hashCode(schemaPath);
+        return result;
     }
 
     @Override
-    public String toString() {
-        return "grouping " + qname.getLocalName();
-    }
-
-    private final class GroupingDefinitionImpl implements GroupingDefinition {
-        private final QName qname;
-        private SchemaPath path;
-        private String description;
-        private String reference;
-        private Status status;
-        private boolean addedByUses;
-        private Map<QName, DataSchemaNode> childNodes = Collections.emptyMap();
-        private Set<GroupingDefinition> groupings = Collections.emptySet();
-        private Set<TypeDefinition<?>> typeDefinitions = Collections.emptySet();
-        private Set<UsesNode> uses = Collections.emptySet();
-        private List<UnknownSchemaNode> unknownNodes = Collections.emptyList();
-
-        private GroupingDefinitionImpl(final QName qname) {
-            this.qname = qname;
-        }
-
-        @Override
-        public QName getQName() {
-            return qname;
-        }
-
-        @Override
-        public SchemaPath getPath() {
-            return path;
-        }
-
-        private void setPath(SchemaPath path) {
-            this.path = path;
-        }
-
-        @Override
-        public String getDescription() {
-            return description;
-        }
-
-        private void setDescription(String description) {
-            this.description = description;
-        }
-
-        @Override
-        public String getReference() {
-            return reference;
-        }
-
-        private void setReference(String reference) {
-            this.reference = reference;
-        }
-
-        @Override
-        public Status getStatus() {
-            return status;
-        }
-
-        private void setStatus(Status status) {
-            this.status = status;
-        }
-
-        @Override
-        public boolean isAddedByUses() {
-            return addedByUses;
-        }
-
-        private void setAddedByUses(final boolean addedByUses) {
-            this.addedByUses = addedByUses;
-        }
-
-        @Override
-        public Set<DataSchemaNode> getChildNodes() {
-            final Set<DataSchemaNode> result = new TreeSet<DataSchemaNode>(Comparators.SCHEMA_NODE_COMP);
-            result.addAll(childNodes.values());
-            return result;
-        }
-
-        private void setChildNodes(Map<QName, DataSchemaNode> childNodes) {
-            this.childNodes = childNodes;
-        }
-
-        @Override
-        public Set<GroupingDefinition> getGroupings() {
-            return groupings;
-        }
-
-        private void setGroupings(Set<GroupingDefinition> groupings) {
-            this.groupings = groupings;
-        }
-
-        @Override
-        public Set<UsesNode> getUses() {
-            return uses;
-        }
-
-        private void setUses(Set<UsesNode> uses) {
-            this.uses = uses;
-        }
-
-        @Override
-        public Set<TypeDefinition<?>> getTypeDefinitions() {
-            return typeDefinitions;
-        }
-
-        private void setTypeDefinitions(Set<TypeDefinition<?>> typeDefinitions) {
-            this.typeDefinitions = typeDefinitions;
-        }
-
-        @Override
-        public List<UnknownSchemaNode> getUnknownSchemaNodes() {
-            return unknownNodes;
+    public boolean equals(final Object obj) {
+        if (this == obj) {
+            return true;
         }
-
-        private void setUnknownSchemaNodes(List<UnknownSchemaNode> unknownNodes) {
-            if (unknownNodes != null) {
-                this.unknownNodes = unknownNodes;
-            }
+        if (obj == null) {
+            return false;
         }
-
-        @Override
-        public DataSchemaNode getDataChildByName(QName name) {
-            return childNodes.get(name);
+        if (getClass() != obj.getClass()) {
+            return false;
         }
-
-        @Override
-        public DataSchemaNode getDataChildByName(String name) {
-            DataSchemaNode result = null;
-            for (Map.Entry<QName, DataSchemaNode> entry : childNodes.entrySet()) {
-                if (entry.getKey().getLocalName().equals(name)) {
-                    result = entry.getValue();
-                    break;
-                }
-            }
-            return result;
+        if (!super.equals(obj)) {
+            return false;
         }
-
-        @Override
-        public int hashCode() {
-            final int prime = 31;
-            int result = 1;
-            result = prime * result + ((qname == null) ? 0 : qname.hashCode());
-            result = prime * result + ((path == null) ? 0 : path.hashCode());
-            return result;
-        }
-
-        @Override
-        public boolean equals(Object obj) {
-            if (this == obj) {
-                return true;
-            }
-            if (obj == null) {
+        final GroupingBuilderImpl other = (GroupingBuilderImpl) obj;
+        if (getParent() == null) {
+            if (other.getParent() != null) {
                 return false;
             }
-            if (getClass() != obj.getClass()) {
-                return false;
-            }
-            final GroupingDefinitionImpl other = (GroupingDefinitionImpl) obj;
-            if (qname == null) {
-                if (other.qname != null) {
-                    return false;
-                }
-            } else if (!qname.equals(other.qname)) {
-                return false;
-            }
-            if (path == null) {
-                if (other.path != null) {
-                    return false;
-                }
-            } else if (!path.equals(other.path)) {
+        } else if (!getParent().equals(other.getParent())) {
+            return false;
+        }
+        if (schemaPath == null) {
+            if (other.schemaPath != null) {
                 return false;
             }
-            return true;
+        } else if (!schemaPath.equals(other.schemaPath)) {
+            return false;
         }
+        return true;
+    }
 
-        @Override
-        public String toString() {
-            StringBuilder sb = new StringBuilder(GroupingDefinitionImpl.class.getSimpleName());
-            sb.append("[");
-            sb.append("qname=" + qname);
-            sb.append("]");
-            return sb.toString();
-        }
+    @Override
+    protected String getStatementName() {
+        return "grouping";
     }
 
 }