BUG-865: deprecate pre-Beryllium parser elements
[yangtools.git] / yang / yang-parser-impl / src / main / java / org / opendaylight / yangtools / yang / parser / builder / impl / ChoiceBuilder.java
index 05095fe93680b6031f735ec5461e4c9dbf8628ad..03c1341184a34d52f74aec1b6c74b5d2137c8827 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.Objects;
 import java.util.Set;
 import java.util.TreeSet;
-
 import org.opendaylight.yangtools.yang.common.QName;
 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
-import org.opendaylight.yangtools.yang.model.api.ChoiceNode;
-import org.opendaylight.yangtools.yang.model.api.ConstraintDefinition;
+import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
-import org.opendaylight.yangtools.yang.model.api.Status;
-import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
-import org.opendaylight.yangtools.yang.parser.builder.api.AbstractSchemaNodeBuilder;
 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.GroupingMember;
-import org.opendaylight.yangtools.yang.parser.util.Comparators;
-import org.opendaylight.yangtools.yang.parser.util.ParserUtils;
+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.AbstractSchemaNodeBuilder;
+import org.opendaylight.yangtools.yang.parser.builder.util.Comparators;
 import org.opendaylight.yangtools.yang.parser.util.YangParseException;
 
-public final class ChoiceBuilder extends AbstractSchemaNodeBuilder implements DataSchemaNodeBuilder,
-        AugmentationTargetBuilder, GroupingMember {
-    private boolean isBuilt;
-    private final ChoiceNodeImpl instance;
+/**
+ * @deprecated Pre-Beryllium implementation, scheduled for removal.
+ */
+@Deprecated
+public final class ChoiceBuilder extends AbstractSchemaNodeBuilder implements DataSchemaNodeBuilder, AugmentationTargetBuilder {
+    private ChoiceSchemaNodeImpl instance;
+
     // DataSchemaNode args
     private boolean augmenting;
     private boolean addedByUses;
-    private Boolean configuration;
+    private boolean configuration;
+    private ChoiceSchemaNode originalNode;
+    private ChoiceBuilder originalBuilder;
     private final ConstraintsBuilder constraints;
     // AugmentationTarget args
-    private final Set<AugmentationSchemaBuilder> addedAugmentations = new HashSet<AugmentationSchemaBuilder>();
+    private final Set<AugmentationSchema> augmentations = new HashSet<>();
+    private final List<AugmentationSchemaBuilder> augmentationBuilders = new ArrayList<>();
     // ChoiceNode args
-    private Set<ChoiceCaseNode> cases;
-    private final Set<ChoiceCaseBuilder> addedCases = new HashSet<ChoiceCaseBuilder>();
+    private final Set<ChoiceCaseBuilder> caseBuilders = new HashSet<>();
     private String defaultCase;
 
-    public ChoiceBuilder(final String moduleName, final int line, final QName qname) {
+    public ChoiceBuilder(final String moduleName, final int line, final QName qname, final SchemaPath path) {
         super(moduleName, line, qname);
-        instance = new ChoiceNodeImpl(qname);
-        constraints = new ConstraintsBuilder(moduleName, line);
+        this.schemaPath = path;
+        constraints = new ConstraintsBuilderImpl(moduleName, line);
     }
 
-    @Override
-    public ChoiceNode build() {
-        if (!isBuilt) {
-            instance.setPath(schemaPath);
-            instance.setDescription(description);
-            instance.setReference(reference);
-            instance.setStatus(status);
-            instance.setAugmenting(augmenting);
-            instance.setAddedByUses(addedByUses);
-            instance.setConfiguration(configuration);
-            instance.setConstraints(constraints.build());
-            instance.setDefaultCase(defaultCase);
-
-            // CASES
-            if (cases == null) {
-                cases = new TreeSet<ChoiceCaseNode>(Comparators.SCHEMA_NODE_COMP);
-                for (ChoiceCaseBuilder caseBuilder : addedCases) {
-                    cases.add(caseBuilder.build());
-                }
-            }
-            instance.setCases(cases);
-
-            // AUGMENTATIONS
-            final Set<AugmentationSchema> 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);
+    public ChoiceBuilder(final String moduleName, final int line, final QName qname, final SchemaPath path,
+            final ChoiceSchemaNode base) {
+        super(moduleName, line, qname);
+        this.schemaPath = path;
+        constraints = new ConstraintsBuilderImpl(moduleName, line, base.getConstraints());
+
+        description = base.getDescription();
+        reference = base.getReference();
+        status = base.getStatus();
+        augmenting = base.isAugmenting();
+        addedByUses = base.isAddedByUses();
+        originalNode =  base;
+        configuration = base.isConfiguration();
+        augmentations.addAll(base.getAvailableAugmentations());
+
+        Set<DataSchemaNodeBuilder> wrapped = BuilderUtils.wrapChildNodes(moduleName, line, new HashSet<DataSchemaNode>(
+                base.getCases()), path, qname);
+        for (DataSchemaNodeBuilder wrap : wrapped) {
+            if (wrap instanceof ChoiceCaseBuilder) {
+                caseBuilders.add((ChoiceCaseBuilder) wrap);
             }
-            instance.setUnknownSchemaNodes(unknownNodes);
-
-            isBuilt = true;
         }
-        return instance;
+
+        addedUnknownNodes.addAll(BuilderUtils.wrapUnknownNodes(moduleName, line, base.getUnknownSchemaNodes(), path,
+                qname));
     }
 
     @Override
-    public void rebuild() {
-        isBuilt = false;
-        build();
+    public ChoiceSchemaNode build() {
+        if (instance != null) {
+            return instance;
+        }
+
+        instance = new ChoiceSchemaNodeImpl(qname, schemaPath);
+
+        instance.description = description;
+        instance.reference = reference;
+        instance.status = status;
+        instance.augmenting = augmenting;
+        instance.addedByUses = addedByUses;
+        instance.configuration = configuration;
+
+        instance.constraints = constraints.build();
+        instance.defaultCase = defaultCase;
+
+        // ORIGINAL NODE
+        if (originalNode == null && originalBuilder != null) {
+            originalNode = originalBuilder.build();
+        }
+        instance.original = originalNode;
+
+        // CASES
+        final Set<ChoiceCaseNode> cases = new TreeSet<>(Comparators.SCHEMA_NODE_COMP);
+        for (ChoiceCaseBuilder caseBuilder : caseBuilders) {
+            cases.add(caseBuilder.build());
+        }
+        instance.cases = ImmutableSet.copyOf(cases);
+
+        // AUGMENTATIONS
+        for (AugmentationSchemaBuilder builder : augmentationBuilders) {
+            augmentations.add(builder.build());
+        }
+        instance.augmentations = ImmutableSet.copyOf(augmentations);
+
+        // UNKNOWN NODES
+        for (UnknownSchemaNodeBuilder b : addedUnknownNodes) {
+            unknownNodes.add(b.build());
+        }
+        instance.unknownNodes = ImmutableList.copyOf(unknownNodes);
+
+        return instance;
     }
 
     public Set<ChoiceCaseBuilder> getCases() {
-        return addedCases;
+        return caseBuilders;
     }
 
     /**
      * Get case by name.
-     * 
+     *
      * @param caseName
      *            name of case to search
      * @return case with given name if present, null otherwise
      */
-    public ChoiceCaseBuilder getCaseNodeByName(String caseName) {
-        for (ChoiceCaseBuilder addedCase : addedCases) {
+    public ChoiceCaseBuilder getCaseNodeByName(final String caseName) {
+        for (ChoiceCaseBuilder addedCase : caseBuilders) {
             if (addedCase.getQName().getLocalName().equals(caseName)) {
                 return addedCase;
             }
@@ -125,54 +154,50 @@ public final class ChoiceBuilder extends AbstractSchemaNodeBuilder implements Da
 
     /**
      * Add case node to this choice.
-     * 
+     *
      * If node is not declared with 'case' keyword, create new case builder and
      * make this node child of newly created case.
-     * 
+     *
      * @param caseNode
      *            case node
      */
-    public void addCase(DataSchemaNodeBuilder caseNode) {
+    public void addCase(final DataSchemaNodeBuilder caseNode) {
         QName caseQName = caseNode.getQName();
         String caseName = caseQName.getLocalName();
-        for (ChoiceCaseBuilder addedCase : addedCases) {
-            if (addedCase.getQName().getLocalName().equals(caseName)) {
+
+        for (ChoiceCaseBuilder existingCase : caseBuilders) {
+            if (existingCase.getQName().getLocalName().equals(caseName)) {
                 throw new YangParseException(caseNode.getModuleName(), caseNode.getLine(), "Can not add '" + caseNode
-                        + "' to node '" + qname.getLocalName() + "' in module '" + moduleName
-                        + "': case with same name already declared at line " + addedCase.getLine());
+                        + "' to node '" + qname.getLocalName() + "' in module '" + getModuleName()
+                        + "': case with same name already declared at line " + existingCase.getLine());
             }
         }
 
         if (caseNode instanceof ChoiceCaseBuilder) {
-            addedCases.add((ChoiceCaseBuilder) caseNode);
+            caseBuilders.add((ChoiceCaseBuilder) caseNode);
         } else {
             ChoiceCaseBuilder caseBuilder = new ChoiceCaseBuilder(caseNode.getModuleName(), caseNode.getLine(),
-                    caseQName);
+                    caseQName, caseNode.getPath());
             if (caseNode.isAugmenting()) {
                 // if node is added by augmentation, set case builder augmenting
                 // as true and node augmenting as false
                 caseBuilder.setAugmenting(true);
                 caseNode.setAugmenting(false);
             }
-            caseBuilder.setPath(caseNode.getPath());
-            SchemaPath newPath = ParserUtils.createSchemaPath(caseNode.getPath(), caseQName);
+            SchemaPath newPath = caseNode.getPath().createChild(caseQName);
             caseNode.setPath(newPath);
             caseBuilder.addChildNode(caseNode);
-            addedCases.add(caseBuilder);
+            caseBuilders.add(caseBuilder);
         }
     }
 
-    public void setCases(Set<ChoiceCaseNode> cases) {
-        this.cases = cases;
-    }
-
     @Override
     public boolean isAugmenting() {
         return augmenting;
     }
 
     @Override
-    public void setAugmenting(boolean augmenting) {
+    public void setAugmenting(final boolean augmenting) {
         this.augmenting = augmenting;
     }
 
@@ -186,12 +211,24 @@ public final class ChoiceBuilder extends AbstractSchemaNodeBuilder implements Da
         this.addedByUses = addedByUses;
     }
 
-    public Boolean isConfiguration() {
+    @Override
+    public ChoiceBuilder getOriginal() {
+        return originalBuilder;
+    }
+
+    @Override
+    public void setOriginal(final SchemaNodeBuilder builder) {
+        Preconditions.checkArgument(builder instanceof ChoiceBuilder, "Original of choice cannot be " + builder);
+        this.originalBuilder = (ChoiceBuilder) builder;
+    }
+
+    @Override
+    public boolean isConfiguration() {
         return configuration;
     }
 
     @Override
-    public void setConfiguration(Boolean configuration) {
+    public void setConfiguration(final boolean configuration) {
         this.configuration = configuration;
     }
 
@@ -200,24 +237,20 @@ public final class ChoiceBuilder extends AbstractSchemaNodeBuilder implements Da
         return constraints;
     }
 
-    public Set<AugmentationSchemaBuilder> getAugmentations() {
-        return addedAugmentations;
-    }
-
     @Override
-    public void addAugmentation(AugmentationSchemaBuilder augment) {
-        addedAugmentations.add(augment);
+    public void addAugmentation(final AugmentationSchemaBuilder augment) {
+        augmentationBuilders.add(augment);
     }
 
-    public List<UnknownSchemaNodeBuilder> getUnknownNodes() {
-        return addedUnknownNodes;
+    public List<AugmentationSchemaBuilder> getAugmentationBuilders() {
+        return augmentationBuilders;
     }
 
     public String getDefaultCase() {
         return defaultCase;
     }
 
-    public void setDefaultCase(String defaultCase) {
+    public void setDefaultCase(final String defaultCase) {
         this.defaultCase = defaultCase;
     }
 
@@ -225,12 +258,12 @@ public final class ChoiceBuilder extends AbstractSchemaNodeBuilder implements Da
     public int hashCode() {
         final int prime = 31;
         int result = 1;
-        result = prime * result + ((schemaPath == null) ? 0 : schemaPath.hashCode());
+        result = prime * result + Objects.hashCode(schemaPath);
         return result;
     }
 
     @Override
-    public boolean equals(Object obj) {
+    public boolean equals(final Object obj) {
         if (this == obj) {
             return true;
         }
@@ -248,11 +281,11 @@ public final class ChoiceBuilder extends AbstractSchemaNodeBuilder implements Da
         } else if (!schemaPath.equals(other.schemaPath)) {
             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;
@@ -263,226 +296,4 @@ public final class ChoiceBuilder extends AbstractSchemaNodeBuilder implements Da
         return "choice " + qname.getLocalName();
     }
 
-    public final class ChoiceNodeImpl implements ChoiceNode {
-        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<ChoiceCaseNode> cases = Collections.emptySet();
-        private Set<AugmentationSchema> augmentations = Collections.emptySet();
-        private List<UnknownSchemaNode> unknownNodes = Collections.emptyList();
-        private String defaultCase;
-
-        private ChoiceNodeImpl(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> availableAugmentations) {
-            if (availableAugmentations != null) {
-                this.augmentations = availableAugmentations;
-            }
-        }
-
-        @Override
-        public List<UnknownSchemaNode> getUnknownSchemaNodes() {
-            return unknownNodes;
-        }
-
-        private void setUnknownSchemaNodes(List<UnknownSchemaNode> unknownSchemaNodes) {
-            if (unknownSchemaNodes != null) {
-                this.unknownNodes = unknownSchemaNodes;
-            }
-        }
-
-        @Override
-        public Set<ChoiceCaseNode> getCases() {
-            return cases;
-        }
-
-        @Override
-        public ChoiceCaseNode getCaseNodeByName(final QName name) {
-            if (name == null) {
-                throw new IllegalArgumentException("Choice Case QName cannot be NULL!");
-            }
-            for (final ChoiceCaseNode caseNode : cases) {
-                if (caseNode != null) {
-                    if (name.equals(caseNode.getQName())) {
-                        return caseNode;
-                    }
-                }
-            }
-            return null;
-        }
-
-        @Override
-        public ChoiceCaseNode getCaseNodeByName(final String name) {
-            if (name == null) {
-                throw new IllegalArgumentException("Choice Case string Name cannot be NULL!");
-            }
-            for (final ChoiceCaseNode caseNode : cases) {
-                if (caseNode != null && (caseNode.getQName() != null)) {
-                    if (name.equals(caseNode.getQName().getLocalName())) {
-                        return caseNode;
-                    }
-                }
-            }
-            return null;
-        }
-
-        private void setCases(Set<ChoiceCaseNode> cases) {
-            if (cases != null) {
-                this.cases = cases;
-            }
-        }
-
-        @Override
-        public String getDefaultCase() {
-            return defaultCase;
-        }
-
-        private void setDefaultCase(String defaultCase) {
-            this.defaultCase = defaultCase;
-        }
-
-        public ChoiceBuilder toBuilder() {
-            return ChoiceBuilder.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;
-            }
-            ChoiceNodeImpl other = (ChoiceNodeImpl) 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(ChoiceNodeImpl.class.getSimpleName());
-            sb.append("[");
-            sb.append("qname=" + qname);
-            sb.append("]");
-            return sb.toString();
-        }
-    }
-
 }