BUG-865: deprecate pre-Beryllium parser elements
[yangtools.git] / yang / yang-parser-impl / src / main / java / org / opendaylight / yangtools / yang / parser / builder / impl / ContainerSchemaNodeBuilder.java
index bfacd3b894ce008c428861dd1f834812144c8fb2..421d35ff72878880c0fbf590e53fc69bae61fc95 100644 (file)
  */
 package org.opendaylight.yangtools.yang.parser.builder.impl;
 
+import com.google.common.base.Preconditions;
+import com.google.common.collect.ImmutableList;
+import com.google.common.collect.ImmutableSet;
 import java.util.ArrayList;
-import java.util.Collections;
-import java.util.HashSet;
 import java.util.List;
-import java.util.Map;
-import java.util.Set;
-import java.util.TreeMap;
-import java.util.TreeSet;
-
+import java.util.Objects;
 import org.opendaylight.yangtools.yang.common.QName;
 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
-import org.opendaylight.yangtools.yang.model.api.ConstraintDefinition;
 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
-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.AugmentationSchemaBuilder;
 import org.opendaylight.yangtools.yang.parser.builder.api.AugmentationTargetBuilder;
+import org.opendaylight.yangtools.yang.parser.builder.api.ConstraintsBuilder;
 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.GroupingMember;
-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;
-
-public final class ContainerSchemaNodeBuilder extends AbstractDataNodeContainerBuilder implements
-        AugmentationTargetBuilder, DataSchemaNodeBuilder, GroupingMember {
-    private boolean isBuilt;
-    private final ContainerSchemaNodeImpl instance;
+import org.opendaylight.yangtools.yang.parser.builder.api.SchemaNodeBuilder;
+import org.opendaylight.yangtools.yang.parser.builder.api.UnknownSchemaNodeBuilder;
+import org.opendaylight.yangtools.yang.parser.builder.util.AbstractDocumentedDataNodeContainerBuilder;
 
+/**
+ * @deprecated Pre-Beryllium implementation, scheduled for removal.
+ */
+@Deprecated
+public final class ContainerSchemaNodeBuilder extends AbstractDocumentedDataNodeContainerBuilder implements
+        AugmentationTargetBuilder, DataSchemaNodeBuilder {
+    private ContainerSchemaNodeImpl instance;
+    private boolean presence;
     // SchemaNode args
-    private SchemaPath schemaPath;
-    private String description;
-    private String reference;
-    private Status status = Status.CURRENT;
+    private SchemaPath path;
     // DataSchemaNode args
     private boolean augmenting;
     private boolean addedByUses;
-    private Boolean configuration;
+    private boolean configuration;
+    private ContainerSchemaNode originalNode;
+    private ContainerSchemaNodeBuilder originalBuilder;
     private final ConstraintsBuilder constraints;
-    // DataNodeContainer args
-    private Set<TypeDefinition<?>> typedefs;
-    private final Set<TypeDefinitionBuilder> addedTypedefs = new HashSet<TypeDefinitionBuilder>();
-    private Set<UsesNode> usesNodes;
-    private final Set<UsesNodeBuilder> addedUsesNodes = new HashSet<UsesNodeBuilder>();
     // AugmentationTarget args
-    private Set<AugmentationSchema> augmentations;
-    private final Set<AugmentationSchemaBuilder> addedAugmentations = new HashSet<AugmentationSchemaBuilder>();
-    // ContainerSchemaNode args
-    private boolean presence;
+    private final List<AugmentationSchema> augmentations = new ArrayList<>();
+    private final List<AugmentationSchemaBuilder> augmentationBuilders = new ArrayList<>();
 
-    public ContainerSchemaNodeBuilder(final String moduleName, final int line, final QName qname,
-            final SchemaPath schemaPath) {
+    public ContainerSchemaNodeBuilder(final String moduleName, final int line, final QName qname, final SchemaPath path) {
         super(moduleName, line, qname);
-        this.schemaPath = schemaPath;
-        instance = new ContainerSchemaNodeImpl(qname);
-        constraints = new ConstraintsBuilder(moduleName, line);
+        this.path = Preconditions.checkNotNull(path, "Schema Path must not be null");
+        this.constraints = new ConstraintsBuilderImpl(moduleName, line);
     }
 
-    @Override
-    public ContainerSchemaNode build() {
-        if (!isBuilt) {
-            instance.setPath(schemaPath);
-            instance.setDescription(description);
-            instance.setReference(reference);
-            instance.setStatus(status);
-            instance.setPresenceContainer(presence);
-            instance.setAugmenting(augmenting);
-            instance.setAddedByUses(addedByUses);
-
-            // if this builder represents rpc input or output, it can has
-            // configuration value set to null
-            if (configuration == null) {
-                configuration = false;
-            }
-            instance.setConfiguration(configuration);
-
-            // USES
-            if (usesNodes == null) {
-                usesNodes = new HashSet<UsesNode>();
-                for (UsesNodeBuilder builder : addedUsesNodes) {
-                    usesNodes.add(builder.build());
-                }
-            }
-            instance.setUses(usesNodes);
-
-            // 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);
-
-            // AUGMENTATIONS
-            if (augmentations == null) {
-                augmentations = new HashSet<AugmentationSchema>();
-                for (AugmentationSchemaBuilder builder : addedAugmentations) {
-                    augmentations.add(builder.build());
-                }
-            }
-            instance.setAvailableAugmentations(augmentations);
-
-            // 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);
+    // constructor for uses
+    public ContainerSchemaNodeBuilder(final String moduleName, final int line, final QName qname,
+            final SchemaPath path, final ContainerSchemaNode base) {
+        super(moduleName, line, qname, path, base);
+        this.path = Preconditions.checkNotNull(path, "Schema Path must not be null");
 
-            instance.setConstraints(constraints.build());
-            instance.setAvailableAugmentations(augmentations);
+        constraints = new ConstraintsBuilderImpl(moduleName, line, base.getConstraints());
 
-            isBuilt = true;
-        }
-        return instance;
-    }
+        augmenting = base.isAugmenting();
+        addedByUses = base.isAddedByUses();
+        originalNode = base;
+        configuration = base.isConfiguration();
+        presence = base.isPresenceContainer();
 
-    @Override
-    public void rebuild() {
-        isBuilt = false;
-        build();
-    }
+        augmentations.addAll(base.getAvailableAugmentations());
 
-    @Override
-    public void setQName(QName qname) {
-        this.qname = qname;
     }
 
     @Override
-    public Set<TypeDefinitionBuilder> getTypeDefinitionBuilders() {
-        return addedTypedefs;
+    protected String getStatementName() {
+        return "container";
     }
 
     @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 ContainerSchemaNode build() {
+        if (instance != null) {
+            return instance;
         }
-        addedTypedefs.add(type);
-    }
-
-    public void setTypedefs(final Set<TypeDefinition<?>> typedefs) {
-        this.typedefs = typedefs;
-    }
 
-    public Set<AugmentationSchemaBuilder> getAugmentations() {
-        return addedAugmentations;
-    }
+        buildChildren();
+        instance = new ContainerSchemaNodeImpl(this);
 
-    @Override
-    public void addAugmentation(AugmentationSchemaBuilder augment) {
-        addedAugmentations.add(augment);
-    }
+        instance.augmenting = augmenting;
+        instance.addedByUses = addedByUses;
+        instance.configuration = configuration;
+        instance.constraints = constraints.build();
+        instance.presence = presence;
 
-    public void setAugmentations(final Set<AugmentationSchema> augmentations) {
-        this.augmentations = augmentations;
-    }
-
-    public SchemaPath getPath() {
-        return schemaPath;
-    }
+        // ORIGINAL NODE
+        if (originalNode == null && originalBuilder != null) {
+            originalNode = originalBuilder.build();
+        }
+        instance.original = originalNode;
 
-    @Override
-    public void setPath(final SchemaPath schemaPath) {
-        this.schemaPath = schemaPath;
-    }
+        // AUGMENTATIONS
+        for (AugmentationSchemaBuilder builder : augmentationBuilders) {
+            augmentations.add(builder.build());
+        }
+        instance.augmentations = ImmutableSet.copyOf(augmentations);
 
-    @Override
-    public String getDescription() {
-        return description;
-    }
+        // UNKNOWN NODES
+        for (UnknownSchemaNodeBuilder b : addedUnknownNodes) {
+            unknownNodes.add(b.build());
+        }
+        instance.unknownNodes = ImmutableList.copyOf(unknownNodes);
 
-    @Override
-    public void setDescription(final String description) {
-        this.description = description;
+        return instance;
     }
 
-    @Override
-    public String getReference() {
-        return reference;
+    public List<AugmentationSchemaBuilder> getAugmentationBuilders() {
+        return augmentationBuilders;
     }
 
     @Override
-    public void setReference(String reference) {
-        this.reference = reference;
+    public void addAugmentation(final AugmentationSchemaBuilder augment) {
+        augmentationBuilders.add(augment);
     }
 
     @Override
-    public Status getStatus() {
-        return status;
+    public SchemaPath getPath() {
+        return path;
     }
 
     @Override
-    public void setStatus(Status status) {
-        if (status != null) {
-            this.status = status;
-        }
+    public void setPath(final SchemaPath path) {
+        this.path = path;
     }
 
     @Override
@@ -247,7 +136,7 @@ public final class ContainerSchemaNodeBuilder extends AbstractDataNodeContainerB
     }
 
     @Override
-    public void setAugmenting(boolean augmenting) {
+    public void setAugmenting(final boolean augmenting) {
         this.augmenting = augmenting;
     }
 
@@ -262,39 +151,37 @@ public final class ContainerSchemaNodeBuilder extends AbstractDataNodeContainerB
     }
 
     @Override
-    public Boolean isConfiguration() {
-        return configuration;
+    public ContainerSchemaNodeBuilder getOriginal() {
+        return originalBuilder;
     }
 
     @Override
-    public void setConfiguration(Boolean configuration) {
-        this.configuration = configuration;
+    public void setOriginal(final SchemaNodeBuilder builder) {
+        Preconditions.checkArgument(builder instanceof ContainerSchemaNodeBuilder, "Original of container cannot be "
+                + builder);
+        this.originalBuilder = (ContainerSchemaNodeBuilder) builder;
     }
 
     @Override
-    public ConstraintsBuilder getConstraints() {
-        return constraints;
+    public boolean isConfiguration() {
+        return configuration;
     }
 
     @Override
-    public Set<UsesNodeBuilder> getUsesNodes() {
-        return addedUsesNodes;
+    public void setConfiguration(final boolean configuration) {
+        this.configuration = configuration;
     }
 
     @Override
-    public void addUsesNode(UsesNodeBuilder usesNodeBuilder) {
-        addedUsesNodes.add(usesNodeBuilder);
-    }
-
-    public void setUsesnodes(final Set<UsesNode> usesNodes) {
-        this.usesNodes = usesNodes;
+    public ConstraintsBuilder getConstraints() {
+        return constraints;
     }
 
     public boolean isPresence() {
         return presence;
     }
 
-    public void setPresence(boolean presence) {
+    public void setPresence(final boolean presence) {
         this.presence = presence;
     }
 
@@ -302,12 +189,12 @@ public final class ContainerSchemaNodeBuilder extends AbstractDataNodeContainerB
     public int hashCode() {
         final int prime = 31;
         int result = 1;
-        result = prime * result + ((schemaPath == null) ? 0 : schemaPath.hashCode());
+        result = prime * result + Objects.hashCode(path);
         return result;
     }
 
     @Override
-    public boolean equals(Object obj) {
+    public boolean equals(final Object obj) {
         if (this == obj) {
             return true;
         }
@@ -318,18 +205,18 @@ public final class ContainerSchemaNodeBuilder extends AbstractDataNodeContainerB
             return false;
         }
         ContainerSchemaNodeBuilder other = (ContainerSchemaNodeBuilder) obj;
-        if (schemaPath == null) {
-            if (other.schemaPath != null) {
+        if (path == null) {
+            if (other.path != null) {
                 return false;
             }
-        } else if (!schemaPath.equals(other.schemaPath)) {
+        } else if (!path.equals(other.path)) {
             return false;
         }
-        if (parent == null) {
-            if (other.parent != null) {
+        if (getParent() == null) {
+            if (other.getParent() != null) {
                 return false;
             }
-        } else if (!parent.equals(other.parent)) {
+        } else if (!getParent().equals(other.getParent())) {
             return false;
         }
         return true;
@@ -340,249 +227,4 @@ public final class ContainerSchemaNodeBuilder extends AbstractDataNodeContainerB
         return "container " + qname.getLocalName();
     }
 
-    public final class ContainerSchemaNodeImpl implements ContainerSchemaNode {
-        private final QName qname;
-        private SchemaPath path;
-        private String description;
-        private String reference;
-        private Status status = Status.CURRENT;
-        private boolean augmenting;
-        private boolean addedByUses;
-        private boolean configuration;
-        private ConstraintDefinition constraints;
-        private Set<AugmentationSchema> augmentations = Collections.emptySet();
-        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 boolean presence;
-
-        private ContainerSchemaNodeImpl(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) {
-            if (status != null) {
-                this.status = status;
-            }
-        }
-
-        @Override
-        public boolean isAugmenting() {
-            return augmenting;
-        }
-
-        private void setAugmenting(boolean augmenting) {
-            this.augmenting = augmenting;
-        }
-
-        @Override
-        public boolean isAddedByUses() {
-            return addedByUses;
-        }
-
-        private void setAddedByUses(boolean addedByUses) {
-            this.addedByUses = addedByUses;
-        }
-
-        @Override
-        public boolean isConfiguration() {
-            return configuration;
-        }
-
-        private void setConfiguration(boolean configuration) {
-            this.configuration = configuration;
-        }
-
-        @Override
-        public ConstraintDefinition getConstraints() {
-            return constraints;
-        }
-
-        private void setConstraints(ConstraintDefinition constraints) {
-            this.constraints = constraints;
-        }
-
-        @Override
-        public Set<AugmentationSchema> getAvailableAugmentations() {
-            return augmentations;
-        }
-
-        private void setAvailableAugmentations(Set<AugmentationSchema> augmentations) {
-            if (augmentations != null) {
-                this.augmentations = augmentations;
-            }
-        }
-
-        @Override
-        public Set<DataSchemaNode> getChildNodes() {
-            return new HashSet<DataSchemaNode>(childNodes.values());
-        }
-
-        private void setChildNodes(Map<QName, DataSchemaNode> childNodes) {
-            if (childNodes != null) {
-                this.childNodes = childNodes;
-            }
-        }
-
-        @Override
-        public Set<GroupingDefinition> getGroupings() {
-            return groupings;
-        }
-
-        private void setGroupings(Set<GroupingDefinition> groupings) {
-            if (groupings != null) {
-                this.groupings = groupings;
-            }
-        }
-
-        @Override
-        public DataSchemaNode getDataChildByName(QName name) {
-            return childNodes.get(name);
-        }
-
-        @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;
-        }
-
-        @Override
-        public Set<UsesNode> getUses() {
-            return uses;
-        }
-
-        private void setUses(Set<UsesNode> uses) {
-            if (uses != null) {
-                this.uses = uses;
-            }
-        }
-
-        @Override
-        public boolean isPresenceContainer() {
-            return presence;
-        }
-
-        private void setPresenceContainer(boolean presence) {
-            this.presence = presence;
-        }
-
-        @Override
-        public Set<TypeDefinition<?>> getTypeDefinitions() {
-            return typeDefinitions;
-        }
-
-        private void setTypeDefinitions(Set<TypeDefinition<?>> typeDefinitions) {
-            if (typeDefinitions != null) {
-                this.typeDefinitions = typeDefinitions;
-            }
-        }
-
-        @Override
-        public List<UnknownSchemaNode> getUnknownSchemaNodes() {
-            return unknownNodes;
-        }
-
-        private void setUnknownSchemaNodes(List<UnknownSchemaNode> unknownSchemaNodes) {
-            if (unknownSchemaNodes != null) {
-                this.unknownNodes = unknownSchemaNodes;
-            }
-        }
-
-        public ContainerSchemaNodeBuilder toBuilder() {
-            return ContainerSchemaNodeBuilder.this;
-        }
-
-        @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) {
-                return false;
-            }
-            if (getClass() != obj.getClass()) {
-                return false;
-            }
-            ContainerSchemaNodeImpl other = (ContainerSchemaNodeImpl) 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)) {
-                return false;
-            }
-            return true;
-        }
-
-        @Override
-        public String toString() {
-            StringBuilder sb = new StringBuilder(ContainerSchemaNodeImpl.class.getSimpleName());
-            sb.append("[");
-            sb.append("qname=" + qname);
-            sb.append("]");
-            return sb.toString();
-        }
-    }
-
 }