BUG-576: fixed javadoc warnings.
[yangtools.git] / yang / yang-parser-impl / src / main / java / org / opendaylight / yangtools / yang / parser / builder / impl / AugmentationSchemaBuilderImpl.java
index 8d272ce09bcfbf217c03796f81434b67b16f9912..5d93a06579bea94c8ead4cea608b422dfab68b78 100644 (file)
  */
 package org.opendaylight.yangtools.yang.parser.builder.impl;
 
+import static com.google.common.base.Preconditions.checkNotNull;
+
+import com.google.common.base.Optional;
+import com.google.common.collect.ImmutableList;
 import java.net.URI;
-import java.util.ArrayList;
-import java.util.Collections;
 import java.util.Date;
-import java.util.HashSet;
+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.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;
-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.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.util.YangParseException;
-
-import com.google.common.base.Optional;
-
-public final class AugmentationSchemaBuilderImpl extends AbstractDataNodeContainerBuilder implements
-        AugmentationSchemaBuilder {
-    private boolean built;
-    private final AugmentationSchemaImpl instance;
+import org.opendaylight.yangtools.yang.parser.builder.api.UnknownSchemaNodeBuilder;
+import org.opendaylight.yangtools.yang.parser.builder.util.AbstractDocumentedDataNodeContainer;
+import org.opendaylight.yangtools.yang.parser.builder.util.AbstractDocumentedDataNodeContainerBuilder;
 
+public final class AugmentationSchemaBuilderImpl extends AbstractDocumentedDataNodeContainerBuilder implements AugmentationSchemaBuilder {
+    private final int order;
+    private AugmentationSchemaImpl instance;
     private String whenCondition;
 
     private final String augmentTargetStr;
     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 SchemaPath targetPath, final int order) {
         super(moduleName, line, null);
+        this.order = order;
         this.augmentTargetStr = augmentTargetStr;
-        targetPath = ParserUtils.parseXPathString(augmentTargetStr);
-        instance = new AugmentationSchemaImpl(targetPath);
+        this.targetPath = targetPath;
     }
 
     @Override
-    public Set<GroupingDefinition> getGroupings() {
-        return Collections.emptySet();
+    protected String getStatementName() {
+        return "augment";
     }
 
     @Override
-    public Set<GroupingBuilder> getGroupingBuilders() {
-        return Collections.emptySet();
-    }
-
-    @Override
-    public void addGrouping(final GroupingBuilder grouping) {
-        throw new YangParseException(moduleName, line, "augment can not contains grouping statement");
+    public SchemaPath getPath() {
+        return targetPath;
     }
 
     @Override
-    public SchemaPath getPath() {
-        return targetNodeSchemaPath;
+    public SchemaPath getTargetPath() {
+        return targetPath;
     }
 
     @Override
     public AugmentationSchema build() {
-        if (!built) {
-
-            Builder parent = getParent();
-            if(parent instanceof ModuleBuilder) {
-                ModuleBuilder moduleBuilder = (ModuleBuilder) parent;
-                instance.setNamespace(moduleBuilder.getNamespace());
-                instance.setRevision(moduleBuilder.getRevision());
-            }
-
-            if (parent instanceof UsesNodeBuilder) {
-                ModuleBuilder mb = ParserUtils.getParentModule(this);
-                List<QName> newPath = new ArrayList<>();
-                List<QName> parsedPath = targetPath.getPath();
-                for (QName name : parsedPath) {
-                    newPath.add(new QName(mb.getNamespace(), mb.getRevision(), name.getPrefix(), name.getLocalName()));
-                }
-                instance.setTargetPath(new SchemaPath(newPath, false));
-            } else {
-                instance.setTargetPath(targetNodeSchemaPath);
-            }
+        if (instance != null) {
+            return instance;
+        }
 
-            if(copyOf != null) {
-                instance.setCopyOf(copyOf.build());
-            }
+        buildChildren();
 
-            RevisionAwareXPath whenStmt;
-            if (whenCondition == null) {
-                whenStmt = null;
-            } else {
-                whenStmt = new RevisionAwareXPathImpl(whenCondition, false);
-            }
-            instance.setWhenCondition(whenStmt);
+        instance = new AugmentationSchemaImpl(targetPath, order,this);
 
-            // CHILD NODES
-            for (DataSchemaNodeBuilder node : addedChildNodes) {
-                DataSchemaNode child = node.build();
-                childNodes.add(child);
-            }
-            instance.addChildNodes(childNodes);
+        Builder parent = getParent();
+        if (parent instanceof ModuleBuilder) {
+            ModuleBuilder moduleBuilder = (ModuleBuilder) parent;
+            instance.namespace = moduleBuilder.getNamespace();
+            instance.revision = moduleBuilder.getRevision();
+        }
 
-            // USES
-            for (UsesNodeBuilder builder : addedUsesNodes) {
-                usesNodes.add(builder.build());
-            }
-            instance.addUses(usesNodes);
+        if (copyOf != null) {
+            instance.setCopyOf(copyOf.build());
+        }
 
-            // UNKNOWN NODES
-            for (UnknownSchemaNodeBuilder b : addedUnknownNodes) {
-                unknownNodes.add(b.build());
-            }
-            Collections.sort(unknownNodes, Comparators.SCHEMA_NODE_COMP);
-            instance.addUnknownSchemaNodes(unknownNodes);
+        RevisionAwareXPath whenStmt;
+        if (whenCondition == null) {
+            whenStmt = null;
+        } else {
+            whenStmt = new RevisionAwareXPathImpl(whenCondition, false);
+        }
+        instance.whenCondition = whenStmt;
 
-            built = true;
+        // UNKNOWN NODES
+        for (UnknownSchemaNodeBuilder b : addedUnknownNodes) {
+            unknownNodes.add(b.build());
         }
+        instance.unknownNodes = ImmutableList.copyOf(unknownNodes);
+
         return instance;
     }
 
@@ -162,66 +120,14 @@ public final class AugmentationSchemaBuilderImpl extends AbstractDataNodeContain
         this.whenCondition = whenCondition;
     }
 
-    @Override
-    public Set<TypeDefinitionBuilder> getTypeDefinitionBuilders() {
-        return Collections.emptySet();
-    }
-
-    @Override
-    public void addTypedef(final TypeDefinitionBuilder type) {
-        throw new YangParseException(moduleName, line, "Augmentation can not contains typedef statement.");
-    }
-
-    @Override
-    public String getDescription() {
-        return instance.description;
-    }
-
-    @Override
-    public void setDescription(final String description) {
-        instance.description = description;
-    }
-
-    @Override
-    public String getReference() {
-        return instance.reference;
-    }
-
-    @Override
-    public void setReference(final String reference) {
-        instance.reference = reference;
-    }
-
-    @Override
-    public Status getStatus() {
-        return instance.status;
-    }
-
-    @Override
-    public void setStatus(final Status status) {
-        if (status != null) {
-            instance.status = status;
-        }
-    }
-
     @Override
     public String getTargetPathAsString() {
         return augmentTargetStr;
     }
 
     @Override
-    public SchemaPath getTargetPath() {
-        return targetPath;
-    }
-
-    @Override
-    public SchemaPath getTargetNodeSchemaPath() {
-        return targetNodeSchemaPath;
-    }
-
-    @Override
-    public void setTargetNodeSchemaPath(final SchemaPath path) {
-        this.targetNodeSchemaPath = path;
+    public int getOrder() {
+        return order;
     }
 
     @Override
@@ -230,7 +136,7 @@ public final class AugmentationSchemaBuilderImpl extends AbstractDataNodeContain
         int result = 1;
         result = prime * result + ((augmentTargetStr == null) ? 0 : augmentTargetStr.hashCode());
         result = prime * result + ((whenCondition == null) ? 0 : whenCondition.hashCode());
-        result = prime * result + ((addedChildNodes == null) ? 0 : addedChildNodes.hashCode());
+        result = prime * result + getChildNodeBuilders().hashCode();
         return result;
     }
 
@@ -260,11 +166,7 @@ public final class AugmentationSchemaBuilderImpl extends AbstractDataNodeContain
         } else if (!whenCondition.equals(other.whenCondition)) {
             return false;
         }
-        if (addedChildNodes == null) {
-            if (other.addedChildNodes != null) {
-                return false;
-            }
-        } else if (!addedChildNodes.equals(other.addedChildNodes)) {
+        if (!getChildNodeBuilders().equals(other.getChildNodeBuilders())) {
             return false;
         }
         return true;
@@ -279,22 +181,20 @@ public final class AugmentationSchemaBuilderImpl extends AbstractDataNodeContain
         copyOf = old;
     }
 
-    private static final class AugmentationSchemaImpl implements AugmentationSchema, NamespaceRevisionAware {
-        private SchemaPath targetPath;
+    private static final class AugmentationSchemaImpl extends AbstractDocumentedDataNodeContainer implements AugmentationSchema, NamespaceRevisionAware, Comparable<AugmentationSchemaImpl> {
+        private final int order;
+        private final SchemaPath targetPath;
         private RevisionAwareXPath whenCondition;
-        private final Set<DataSchemaNode> childNodes = new TreeSet<>(Comparators.SCHEMA_NODE_COMP);
-        private final Set<UsesNode> uses = new HashSet<>();
-        private String description;
-        private String reference;
-        private Status status;
 
         private URI namespace;
         private Date revision;
-        private final List<UnknownSchemaNode> unknownNodes = new ArrayList<>();
+        private ImmutableList<UnknownSchemaNode> unknownNodes;
         private AugmentationSchema copyOf;
 
-        private AugmentationSchemaImpl(final SchemaPath targetPath) {
+        public AugmentationSchemaImpl(final SchemaPath targetPath, final int order, final AugmentationSchemaBuilderImpl builder) {
+            super(builder);
             this.targetPath = targetPath;
+            this.order = order;
         }
 
         public void setCopyOf(final AugmentationSchema build) {
@@ -305,98 +205,20 @@ public final class AugmentationSchemaBuilderImpl extends AbstractDataNodeContain
         public Optional<AugmentationSchema> getOriginalDefinition() {
             return Optional.fromNullable(this.copyOf);
         }
+
         @Override
         public SchemaPath getTargetPath() {
             return targetPath;
         }
 
-        private void setTargetPath(final SchemaPath path) {
-            this.targetPath = path;
-        }
-
         @Override
         public RevisionAwareXPath getWhenCondition() {
             return whenCondition;
         }
 
-        private void setWhenCondition(final RevisionAwareXPath whenCondition) {
-            this.whenCondition = whenCondition;
-        }
-
-        @Override
-        public Set<DataSchemaNode> getChildNodes() {
-            return Collections.unmodifiableSet(childNodes);
-        }
-
-        private void addChildNodes(final Set<DataSchemaNode> childNodes) {
-            if (childNodes != null) {
-                this.childNodes.addAll(childNodes);
-            }
-        }
-
-        /**
-         * Always returns an empty set, because augment can not contains
-         * grouping statement.
-         */
-        @Override
-        public Set<GroupingDefinition> getGroupings() {
-            return Collections.emptySet();
-        }
-
-        @Override
-        public Set<UsesNode> getUses() {
-            return Collections.unmodifiableSet(uses);
-        }
-
-        private void addUses(final Set<UsesNode> uses) {
-            if (uses != null) {
-                this.uses.addAll(uses);
-            }
-        }
-
-        /**
-         * Always returns an empty set, because augment can not contains type
-         * definitions.
-         */
-        @Override
-        public Set<TypeDefinition<?>> getTypeDefinitions() {
-            return Collections.emptySet();
-        }
-
-        @Override
-        public String getDescription() {
-            return description;
-        }
-
-        @Override
-        public String getReference() {
-            return reference;
-        }
-
-        @Override
-        public Status getStatus() {
-            return status;
-        }
-
         @Override
         public List<UnknownSchemaNode> getUnknownSchemaNodes() {
-            return Collections.unmodifiableList(unknownNodes);
-        }
-
-        private void addUnknownSchemaNodes(final 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(final String name) {
-            return getChildNode(childNodes, name);
+            return unknownNodes;
         }
 
         @Override
@@ -404,26 +226,18 @@ public final class AugmentationSchemaBuilderImpl extends AbstractDataNodeContain
             return namespace;
         }
 
-        protected void setNamespace(final URI namespace) {
-            this.namespace = namespace;
-        }
-
         @Override
         public Date getRevision() {
             return revision;
         }
 
-        protected void setRevision(final Date revision) {
-            this.revision = revision;
-        }
-
         @Override
         public int hashCode() {
             final int prime = 17;
             int result = 1;
             result = prime * result + ((targetPath == null) ? 0 : targetPath.hashCode());
             result = prime * result + ((whenCondition == null) ? 0 : whenCondition.hashCode());
-            result = prime * result + ((childNodes == null) ? 0 : childNodes.hashCode());
+            result = prime * result + getChildNodes().hashCode();
             return result;
         }
 
@@ -453,11 +267,7 @@ public final class AugmentationSchemaBuilderImpl extends AbstractDataNodeContain
             } else if (!whenCondition.equals(other.whenCondition)) {
                 return false;
             }
-            if (childNodes == null) {
-                if (other.childNodes != null) {
-                    return false;
-                }
-            } else if (!childNodes.equals(other.childNodes)) {
+            if (!getChildNodes().equals(other.getChildNodes())) {
                 return false;
             }
             return true;
@@ -467,11 +277,31 @@ public final class AugmentationSchemaBuilderImpl extends AbstractDataNodeContain
         public String toString() {
             StringBuilder sb = new StringBuilder(AugmentationSchemaImpl.class.getSimpleName());
             sb.append("[");
-            sb.append("targetPath=" + targetPath);
-            sb.append(", when=" + whenCondition);
+            sb.append("targetPath=").append(targetPath);
+            sb.append(", when=").append(whenCondition);
             sb.append("]");
             return sb.toString();
         }
-    }
 
+        @Override
+        public int compareTo(final AugmentationSchemaImpl o) {
+            checkNotNull(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;
+        }
+    }
 }