BUG 1131: untangling package cyclic dependencies in yang-parser-impl
[yangtools.git] / yang / yang-parser-impl / src / main / java / org / opendaylight / yangtools / yang / parser / builder / impl / AugmentationSchemaBuilderImpl.java
index cdf0fe571865c778e2ea3eddafb87602974ca507..2a73848c29c498828c67b1e94e9c3957e547fc38 100644 (file)
@@ -7,17 +7,25 @@
  */
 package org.opendaylight.yangtools.yang.parser.builder.impl;
 
+import com.google.common.base.Optional;
+import com.google.common.base.Preconditions;
+import com.google.common.collect.ImmutableList;
+import com.google.common.collect.ImmutableSet;
+
+import java.net.URI;
 import java.util.ArrayList;
 import java.util.Collections;
-import java.util.HashSet;
+import java.util.Date;
+import java.util.Iterator;
 import java.util.List;
 import java.util.Set;
-import java.util.TreeSet;
 
 import org.opendaylight.yangtools.yang.common.QName;
+import org.opendaylight.yangtools.yang.common.QNameModule;
 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
+import org.opendaylight.yangtools.yang.model.api.NamespaceRevisionAware;
 import org.opendaylight.yangtools.yang.model.api.RevisionAwareXPath;
 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
 import org.opendaylight.yangtools.yang.model.api.Status;
@@ -25,34 +33,38 @@ 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.model.util.RevisionAwareXPathImpl;
-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.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.UnknownSchemaNodeBuilder;
 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.ParserUtils;
+import org.opendaylight.yangtools.yang.parser.builder.util.AbstractDataNodeContainerBuilder;
 import org.opendaylight.yangtools.yang.parser.util.YangParseException;
 
 public final class AugmentationSchemaBuilderImpl extends AbstractDataNodeContainerBuilder implements
         AugmentationSchemaBuilder {
-    private boolean built;
-    private final AugmentationSchemaImpl instance;
-
+    private final int order;
+    private AugmentationSchemaImpl instance;
     private String whenCondition;
 
+    private String description;
+    private String reference;
+    private Status status = Status.CURRENT;
+
     private final String augmentTargetStr;
-    private SchemaPath targetPath;
+    private final SchemaPath targetPath;
     private SchemaPath targetNodeSchemaPath;
 
     private boolean resolved;
+    private AugmentationSchemaBuilder copyOf;
 
-    public AugmentationSchemaBuilderImpl(final String moduleName, final int line, final String augmentTargetStr) {
+    public AugmentationSchemaBuilderImpl(final String moduleName, final int line, final String augmentTargetStr, final int order) {
         super(moduleName, line, null);
+        this.order = order;
         this.augmentTargetStr = augmentTargetStr;
-        targetPath = ParserUtils.parseXPathString(augmentTargetStr);
-        instance = new AugmentationSchemaImpl(targetPath);
+        targetPath = BuilderUtils.parseXPathString(augmentTargetStr);
     }
 
     @Override
@@ -66,8 +78,8 @@ public final class AugmentationSchemaBuilderImpl extends AbstractDataNodeContain
     }
 
     @Override
-    public void addGrouping(GroupingBuilder grouping) {
-        throw new YangParseException(moduleName, line, "augment can not contains grouping statement");
+    public void addGrouping(final GroupingBuilder grouping) {
+        throw new YangParseException(getModuleName(), grouping.getLine(), "augment can not contains grouping statement");
     }
 
     @Override
@@ -77,39 +89,66 @@ public final class AugmentationSchemaBuilderImpl extends AbstractDataNodeContain
 
     @Override
     public AugmentationSchema build() {
-        if (!built) {
-            instance.setTargetPath(targetNodeSchemaPath);
+        if (instance != null) {
+            return instance;
+        }
 
-            RevisionAwareXPath whenStmt;
-            if (whenCondition == null) {
-                whenStmt = null;
-            } else {
-                whenStmt = new RevisionAwareXPathImpl(whenCondition, false);
-            }
-            instance.setWhenCondition(whenStmt);
+        instance = new AugmentationSchemaImpl(targetPath, order);
 
-            // CHILD NODES
-            for (DataSchemaNodeBuilder node : addedChildNodes) {
-                DataSchemaNode child = node.build();
-                childNodes.add(child);
-            }
-            instance.addChildNodes(childNodes);
+        instance.description = description;
+        instance.reference = reference;
+        instance.status = status;
 
-            // USES
-            for (UsesNodeBuilder builder : addedUsesNodes) {
-                usesNodes.add(builder.build());
-            }
-            instance.addUses(usesNodes);
+        Builder parent = getParent();
+        if (parent instanceof ModuleBuilder) {
+            ModuleBuilder moduleBuilder = (ModuleBuilder) parent;
+            instance.namespace = moduleBuilder.getNamespace();
+            instance.revision = moduleBuilder.getRevision();
+        }
+
+        if (parent instanceof UsesNodeBuilder) {
+            final ModuleBuilder mb = BuilderUtils.getParentModule(this);
+            final QNameModule qm = QNameModule.create(mb.getNamespace(), mb.getRevision());
 
-            // UNKNOWN NODES
-            for (UnknownSchemaNodeBuilder b : addedUnknownNodes) {
-                unknownNodes.add(b.build());
+            List<QName> newPath = new ArrayList<>();
+            for (QName name : targetPath.getPathFromRoot()) {
+                newPath.add(QName.create(qm, name.getPrefix(), name.getLocalName()));
             }
-            Collections.sort(unknownNodes, Comparators.SCHEMA_NODE_COMP);
-            instance.addUnknownSchemaNodes(unknownNodes);
+            instance.targetPath = SchemaPath.create(newPath, false);
+        } else {
+            instance.targetPath = targetNodeSchemaPath;
+        }
+
+        if (copyOf != null) {
+            instance.setCopyOf(copyOf.build());
+        }
+
+        RevisionAwareXPath whenStmt;
+        if (whenCondition == null) {
+            whenStmt = null;
+        } else {
+            whenStmt = new RevisionAwareXPathImpl(whenCondition, false);
+        }
+        instance.whenCondition = whenStmt;
+
+        // CHILD NODES
+        for (DataSchemaNodeBuilder node : addedChildNodes) {
+            childNodes.put(node.getQName(), node.build());
+        }
+        instance.childNodes = ImmutableSet.copyOf(childNodes.values());
 
-            built = true;
+        // USES
+        for (UsesNodeBuilder builder : addedUsesNodes) {
+            usesNodes.add(builder.build());
         }
+        instance.uses = ImmutableSet.copyOf(usesNodes);
+
+        // UNKNOWN NODES
+        for (UnknownSchemaNodeBuilder b : addedUnknownNodes) {
+            unknownNodes.add(b.build());
+        }
+        instance.unknownNodes = ImmutableList.copyOf(unknownNodes);
+
         return instance;
     }
 
@@ -119,15 +158,17 @@ public final class AugmentationSchemaBuilderImpl extends AbstractDataNodeContain
     }
 
     @Override
-    public void setResolved(boolean resolved) {
+    public void setResolved(final boolean resolved) {
         this.resolved = resolved;
     }
 
+    @Override
     public String getWhenCondition() {
         return whenCondition;
     }
 
-    public void addWhenCondition(String whenCondition) {
+    @Override
+    public void addWhenCondition(final String whenCondition) {
         this.whenCondition = whenCondition;
     }
 
@@ -137,40 +178,38 @@ public final class AugmentationSchemaBuilderImpl extends AbstractDataNodeContain
     }
 
     @Override
-    public void addTypedef(TypeDefinitionBuilder type) {
-        throw new YangParseException(moduleName, line, "Augmentation can not contains typedef statement.");
+    public void addTypedef(final TypeDefinitionBuilder type) {
+        throw new YangParseException(getModuleName(), type.getLine(), "Augmentation can not contains typedef statement.");
     }
 
     @Override
     public String getDescription() {
-        return instance.description;
+        return description;
     }
 
     @Override
     public void setDescription(final String description) {
-        instance.description = description;
+        this.description = description;
     }
 
     @Override
     public String getReference() {
-        return instance.reference;
+        return reference;
     }
 
     @Override
     public void setReference(final String reference) {
-        instance.reference = reference;
+        this.reference = reference;
     }
 
     @Override
     public Status getStatus() {
-        return instance.status;
+        return status;
     }
 
     @Override
-    public void setStatus(Status status) {
-        if (status != null) {
-            instance.status = status;
-        }
+    public void setStatus(final Status status) {
+        this.status = Preconditions.checkNotNull(status, "status cannot be null");
     }
 
     @Override
@@ -189,10 +228,15 @@ public final class AugmentationSchemaBuilderImpl extends AbstractDataNodeContain
     }
 
     @Override
-    public void setTargetNodeSchemaPath(SchemaPath path) {
+    public void setTargetNodeSchemaPath(final SchemaPath path) {
         this.targetNodeSchemaPath = path;
     }
 
+    @Override
+    public int getOrder() {
+        return order;
+    }
+
     @Override
     public int hashCode() {
         final int prime = 17;
@@ -204,7 +248,7 @@ public final class AugmentationSchemaBuilderImpl extends AbstractDataNodeContain
     }
 
     @Override
-    public boolean equals(Object obj) {
+    public boolean equals(final Object obj) {
         if (this == obj) {
             return true;
         }
@@ -239,31 +283,48 @@ public final class AugmentationSchemaBuilderImpl extends AbstractDataNodeContain
         return true;
     }
 
+    @Override
     public String toString() {
         return "augment " + augmentTargetStr;
     }
 
-    private final class AugmentationSchemaImpl implements AugmentationSchema {
+    public void setCopyOf(final AugmentationSchemaBuilder old) {
+        copyOf = old;
+    }
+
+    private static final class AugmentationSchemaImpl implements AugmentationSchema, NamespaceRevisionAware,
+            Comparable<AugmentationSchemaImpl> {
+        private final int order;
         private SchemaPath targetPath;
         private RevisionAwareXPath whenCondition;
-        private final Set<DataSchemaNode> childNodes = new TreeSet<>(Comparators.SCHEMA_NODE_COMP);
-        private final Set<UsesNode> uses = new HashSet<>();
+        private ImmutableSet<DataSchemaNode> childNodes;
+        private ImmutableSet<UsesNode> uses;
         private String description;
         private String reference;
         private Status status;
-        private final List<UnknownSchemaNode> unknownNodes = new ArrayList<>();
 
-        private AugmentationSchemaImpl(SchemaPath targetPath) {
+        private URI namespace;
+        private Date revision;
+        private ImmutableList<UnknownSchemaNode> unknownNodes;
+        private AugmentationSchema copyOf;
+
+        public AugmentationSchemaImpl(final SchemaPath targetPath, final int order) {
             this.targetPath = targetPath;
+            this.order = order;
+        }
+
+        public void setCopyOf(final AugmentationSchema build) {
+            this.copyOf = build;
         }
 
         @Override
-        public SchemaPath getTargetPath() {
-            return targetPath;
+        public Optional<AugmentationSchema> getOriginalDefinition() {
+            return Optional.fromNullable(this.copyOf);
         }
 
-        private void setTargetPath(SchemaPath path) {
-            this.targetPath = path;
+        @Override
+        public SchemaPath getTargetPath() {
+            return targetPath;
         }
 
         @Override
@@ -271,19 +332,9 @@ public final class AugmentationSchemaBuilderImpl extends AbstractDataNodeContain
             return whenCondition;
         }
 
-        private void setWhenCondition(RevisionAwareXPath whenCondition) {
-            this.whenCondition = whenCondition;
-        }
-
         @Override
         public Set<DataSchemaNode> getChildNodes() {
-            return Collections.unmodifiableSet(childNodes);
-        }
-
-        private void addChildNodes(Set<DataSchemaNode> childNodes) {
-            if (childNodes != null) {
-                this.childNodes.addAll(childNodes);
-            }
+            return childNodes;
         }
 
         /**
@@ -297,13 +348,7 @@ public final class AugmentationSchemaBuilderImpl extends AbstractDataNodeContain
 
         @Override
         public Set<UsesNode> getUses() {
-            return Collections.unmodifiableSet(uses);
-        }
-
-        private void addUses(Set<UsesNode> uses) {
-            if (uses != null) {
-                this.uses.addAll(uses);
-            }
+            return uses;
         }
 
         /**
@@ -332,23 +377,27 @@ public final class AugmentationSchemaBuilderImpl extends AbstractDataNodeContain
 
         @Override
         public List<UnknownSchemaNode> getUnknownSchemaNodes() {
-            return Collections.unmodifiableList(unknownNodes);
+            return unknownNodes;
         }
 
-        private void addUnknownSchemaNodes(List<UnknownSchemaNode> unknownSchemaNodes) {
-            if (unknownSchemaNodes != null) {
-                this.unknownNodes.addAll(unknownSchemaNodes);
-            }
+        @Override
+        public DataSchemaNode getDataChildByName(final QName name) {
+            return getChildNode(childNodes, name);
         }
 
         @Override
-        public DataSchemaNode getDataChildByName(QName name) {
+        public DataSchemaNode getDataChildByName(final String name) {
             return getChildNode(childNodes, name);
         }
 
         @Override
-        public DataSchemaNode getDataChildByName(String name) {
-            return getChildNode(childNodes, name);
+        public URI getNamespace() {
+            return namespace;
+        }
+
+        @Override
+        public Date getRevision() {
+            return revision;
         }
 
         @Override
@@ -362,7 +411,7 @@ public final class AugmentationSchemaBuilderImpl extends AbstractDataNodeContain
         }
 
         @Override
-        public boolean equals(Object obj) {
+        public boolean equals(final Object obj) {
             if (this == obj) {
                 return true;
             }
@@ -406,6 +455,26 @@ public final class AugmentationSchemaBuilderImpl extends AbstractDataNodeContain
             sb.append("]");
             return sb.toString();
         }
+
+        @Override
+        public int compareTo(final AugmentationSchemaImpl o) {
+            Iterator<QName> thisIt = this.targetPath.getPathFromRoot().iterator();
+            Iterator<QName> otherIt = o.getTargetPath().getPathFromRoot().iterator();
+            while (thisIt.hasNext()) {
+                if (otherIt.hasNext()) {
+                    int comp = thisIt.next().compareTo(otherIt.next());
+                    if (comp != 0) {
+                        return comp;
+                    }
+                } else {
+                    return 1;
+                }
+            }
+            if (otherIt.hasNext()) {
+                return -1;
+            }
+            return this.order - o.order;
+        }
     }
 
 }