BUG-865: deprecate pre-Beryllium parser elements
[yangtools.git] / yang / yang-parser-impl / src / main / java / org / opendaylight / yangtools / yang / parser / builder / impl / LeafSchemaNodeBuilder.java
index cc9d2d7c21f914662bdd18d802fd156b3a4ddecd..1d6fe186755e39ce953b572a86488dbedef4d9a3 100644 (file)
@@ -7,25 +7,28 @@
  */
 package org.opendaylight.yangtools.yang.parser.builder.impl;
 
-import java.util.Collections;
-import java.util.List;
-
+import com.google.common.base.Preconditions;
+import com.google.common.collect.ImmutableList;
+import java.util.Objects;
 import org.opendaylight.yangtools.yang.common.QName;
-import org.opendaylight.yangtools.yang.model.api.ConstraintDefinition;
 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
 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.YangNode;
-import org.opendaylight.yangtools.yang.parser.builder.api.AbstractTypeAwareBuilder;
+import org.opendaylight.yangtools.yang.parser.builder.api.ConstraintsBuilder;
 import org.opendaylight.yangtools.yang.parser.builder.api.DataSchemaNodeBuilder;
-import org.opendaylight.yangtools.yang.parser.util.Comparators;
+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.AbstractTypeAwareBuilder;
 import org.opendaylight.yangtools.yang.parser.util.YangParseException;
 
+/**
+ * @deprecated Pre-Beryllium implementation, scheduled for removal.
+ */
+@Deprecated
 public final class LeafSchemaNodeBuilder extends AbstractTypeAwareBuilder implements DataSchemaNodeBuilder {
-    private boolean isBuilt;
-    private final LeafSchemaNodeImpl instance;
+    private LeafSchemaNodeImpl instance;
+    private String defaultStr;
+    private String unitsStr;
     // SchemaNode args
     private SchemaPath schemaPath;
     private String description;
@@ -34,60 +37,78 @@ public final class LeafSchemaNodeBuilder extends AbstractTypeAwareBuilder implem
     // DataSchemaNode args
     private boolean augmenting;
     private boolean addedByUses;
-    private Boolean configuration;
+    private LeafSchemaNode originalNode;
+    private LeafSchemaNodeBuilder originalBuilder;
+    private boolean configuration;
     private final ConstraintsBuilder constraints;
-    // leaf args
-    private String defaultStr;
-    private String unitsStr;
 
     public LeafSchemaNodeBuilder(final String moduleName, final int line, final QName qname, final SchemaPath schemaPath) {
         super(moduleName, line, qname);
-        this.schemaPath = schemaPath;
-        instance = new LeafSchemaNodeImpl(qname);
-        constraints = new ConstraintsBuilder(moduleName, line);
+        this.schemaPath = Preconditions.checkNotNull(schemaPath, "Schema Path must not be null");
+        constraints = new ConstraintsBuilderImpl(moduleName, line);
+    }
+
+    public LeafSchemaNodeBuilder(final String moduleName, final int line, final QName qname, final SchemaPath path, final LeafSchemaNode base) {
+        super(moduleName, line, qname);
+        this.schemaPath = Preconditions.checkNotNull(path, "Schema Path must not be null");
+        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();
+        this.type = base.getType();
+        unknownNodes.addAll(base.getUnknownSchemaNodes());
+
+        defaultStr = base.getDefault();
+        unitsStr = base.getUnits();
     }
 
     @Override
-    public LeafSchemaNode build(YangNode parent) {
-        if (!isBuilt) {
-            instance.setParent(parent);
-            instance.setPath(schemaPath);
-            instance.setConstraints(constraints.build());
-            instance.setDescription(description);
-            instance.setReference(reference);
-            instance.setStatus(status);
-            instance.setAugmenting(augmenting);
-            instance.setAddedByUses(addedByUses);
-            instance.setConfiguration(configuration);
-            instance.setDefault(defaultStr);
-            instance.setUnits(unitsStr);
-
-            if (type == null && typedef == null) {
-                throw new YangParseException(moduleName, line, "Failed to resolve leaf type.");
-            }
+    public LeafSchemaNode build() {
+        if (instance != null) {
+            return instance;
+        }
 
-            // TYPE
-            if (type == null) {
-                instance.setType(typedef.build(instance));
-            } else {
-                instance.setType(type);
-            }
+        instance = new LeafSchemaNodeImpl(qname, schemaPath);
 
-            // UNKNOWN NODES
-            for (UnknownSchemaNodeBuilder b : addedUnknownNodes) {
-                unknownNodes.add(b.build(instance));
-            }
-            Collections.sort(unknownNodes, Comparators.SCHEMA_NODE_COMP);
-            instance.setUnknownSchemaNodes(unknownNodes);
+        instance.description = description;
+        instance.reference = reference;
+        instance.status = status;
+        instance.augmenting = augmenting;
+        instance.addedByUses = addedByUses;
+        instance.configuration = configuration;
+        instance.constraintsDef = constraints.build();
+        instance.defaultStr = defaultStr;
+        instance.unitsStr = unitsStr;
 
-            isBuilt = true;
+        if (type == null && typedef == null) {
+            throw new YangParseException(getModuleName(), getLine(), "Failed to resolve leaf type.");
         }
-        return instance;
-    }
 
-    @Override
-    public void setQName(QName qname) {
-        this.qname = qname;
+        // TYPE
+        if (type == null) {
+            instance.type = typedef.build();
+        } else {
+            instance.type = type;
+        }
+
+        // ORIGINAL NODE
+        if (originalNode == null && originalBuilder != null) {
+            originalNode = originalBuilder.build();
+        }
+        instance.original = originalNode;
+
+        // UNKNOWN NODES
+        for (UnknownSchemaNodeBuilder b : addedUnknownNodes) {
+            unknownNodes.add(b.build());
+        }
+        instance.unknownNodes = ImmutableList.copyOf(unknownNodes);
+
+        return instance;
     }
 
     @Override
@@ -132,9 +153,7 @@ public final class LeafSchemaNodeBuilder extends AbstractTypeAwareBuilder implem
 
     @Override
     public void setStatus(final Status status) {
-        if (status != null) {
-            this.status = status;
-        }
+        this.status = Preconditions.checkNotNull(status, "status cannot be null");
     }
 
     @Override
@@ -158,12 +177,23 @@ public final class LeafSchemaNodeBuilder extends AbstractTypeAwareBuilder implem
     }
 
     @Override
-    public Boolean isConfiguration() {
+    public LeafSchemaNodeBuilder getOriginal() {
+        return originalBuilder;
+    }
+
+    @Override
+    public void setOriginal(final SchemaNodeBuilder builder) {
+        Preconditions.checkArgument(builder instanceof LeafSchemaNodeBuilder, "Original of leaf cannot be " + builder);
+        this.originalBuilder = (LeafSchemaNodeBuilder) builder;
+    }
+
+    @Override
+    public boolean isConfiguration() {
         return configuration;
     }
 
     @Override
-    public void setConfiguration(final Boolean configuration) {
+    public void setConfiguration(final boolean configuration) {
         this.configuration = configuration;
     }
 
@@ -171,7 +201,7 @@ public final class LeafSchemaNodeBuilder extends AbstractTypeAwareBuilder implem
         return defaultStr;
     }
 
-    public void setDefaultStr(String defaultStr) {
+    public void setDefaultStr(final String defaultStr) {
         this.defaultStr = defaultStr;
     }
 
@@ -179,7 +209,7 @@ public final class LeafSchemaNodeBuilder extends AbstractTypeAwareBuilder implem
         return unitsStr;
     }
 
-    public void setUnits(String unitsStr) {
+    public void setUnits(final String unitsStr) {
         this.unitsStr = unitsStr;
     }
 
@@ -187,12 +217,12 @@ public final class LeafSchemaNodeBuilder extends AbstractTypeAwareBuilder implem
     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;
         }
@@ -210,11 +240,11 @@ public final class LeafSchemaNodeBuilder extends AbstractTypeAwareBuilder implem
         } else if (!schemaPath.equals(other.schemaPath)) {
             return false;
         }
-        if (parentBuilder == null) {
-            if (other.parentBuilder != null) {
+        if (getParent() == null) {
+            if (other.getParent() != null) {
                 return false;
             }
-        } else if (!parentBuilder.equals(other.parentBuilder)) {
+        } else if (!getParent().equals(other.getParent())) {
             return false;
         }
         return true;
@@ -225,199 +255,4 @@ public final class LeafSchemaNodeBuilder extends AbstractTypeAwareBuilder implem
         return "leaf " + qname.getLocalName();
     }
 
-    private final class LeafSchemaNodeImpl implements LeafSchemaNode {
-        private final QName qname;
-        private SchemaPath path;
-        private YangNode parent;
-        private String description;
-        private String reference;
-        private Status status = Status.CURRENT;
-        private boolean augmenting;
-        private boolean addedByUses;
-        private boolean configuration;
-        private ConstraintDefinition constraintsDef;
-        private TypeDefinition<?> type;
-        private List<UnknownSchemaNode> unknownNodes = Collections.emptyList();
-        private String defaultStr;
-        private String unitsStr;
-
-        private LeafSchemaNodeImpl(final QName qname) {
-            this.qname = qname;
-        }
-
-        @Override
-        public QName getQName() {
-            return qname;
-        }
-
-        @Override
-        public SchemaPath getPath() {
-            return path;
-        }
-
-        private void setPath(final SchemaPath path) {
-            this.path = path;
-        }
-
-        @Override
-        public YangNode getParent() {
-            return parent;
-        }
-
-        private void setParent(YangNode parent) {
-            this.parent = parent;
-        }
-
-        @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(final boolean addedByUses) {
-            this.addedByUses = addedByUses;
-        }
-
-        @Override
-        public boolean isConfiguration() {
-            return configuration;
-        }
-
-        private void setConfiguration(boolean configuration) {
-            this.configuration = configuration;
-        }
-
-        @Override
-        public ConstraintDefinition getConstraints() {
-            return constraintsDef;
-        }
-
-        private void setConstraints(ConstraintDefinition constraintsDef) {
-            this.constraintsDef = constraintsDef;
-        }
-
-        @Override
-        public TypeDefinition<?> getType() {
-            return type;
-        }
-
-        private void setType(TypeDefinition<? extends TypeDefinition<?>> type) {
-            this.type = type;
-        }
-
-        @Override
-        public List<UnknownSchemaNode> getUnknownSchemaNodes() {
-            return unknownNodes;
-        }
-
-        private void setUnknownSchemaNodes(List<UnknownSchemaNode> unknownNodes) {
-            if (unknownNodes != null) {
-                this.unknownNodes = unknownNodes;
-            }
-        }
-
-        @Override
-        public String getDefault() {
-            return defaultStr;
-        }
-
-        private void setDefault(String defaultStr) {
-            this.defaultStr = defaultStr;
-        }
-
-        @Override
-        public String getUnits() {
-            return unitsStr;
-        }
-
-        public void setUnits(String unitsStr) {
-            this.unitsStr = unitsStr;
-        }
-
-        @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;
-            }
-            LeafSchemaNodeImpl other = (LeafSchemaNodeImpl) 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(LeafSchemaNodeImpl.class.getSimpleName());
-            sb.append("[");
-            sb.append("qname=" + qname);
-            sb.append(", path=" + path);
-            sb.append("]");
-            return sb.toString();
-        }
-    }
-
 }