Fixed bugs in naming conventions of packages.
[controller.git] / opendaylight / sal / yang-prototype / yang / yang-model-util / src / main / java / org / opendaylight / controller / yang / model / util / AbstractUnsignedInteger.java
diff --git a/opendaylight/sal/yang-prototype/yang/yang-model-util/src/main/java/org/opendaylight/controller/yang/model/util/AbstractUnsignedInteger.java b/opendaylight/sal/yang-prototype/yang/yang-model-util/src/main/java/org/opendaylight/controller/yang/model/util/AbstractUnsignedInteger.java
new file mode 100644 (file)
index 0000000..c444ce9
--- /dev/null
@@ -0,0 +1,209 @@
+/**
+ * 
+ */
+package org.opendaylight.controller.yang.model.util;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+
+import org.opendaylight.controller.yang.common.QName;
+import org.opendaylight.controller.yang.model.api.SchemaPath;
+import org.opendaylight.controller.yang.model.api.Status;
+import org.opendaylight.controller.yang.model.api.UnknownSchemaNode;
+import org.opendaylight.controller.yang.model.api.type.RangeConstraint;
+import org.opendaylight.controller.yang.model.api.type.UnsignedIntegerTypeDefinition;
+
+/**
+ * The Abstract Integer class defines implementation of IntegerTypeDefinition
+ * interface which represents UNSIGNED Integer values defined in Yang language. <br>
+ * The integer built-in types in Yang are uint8,  uint16, uint32, and uint64. They
+ * represent unsigned integers of different sizes:
+ * 
+ * <ul>
+ * <li>uint8 - represents integer values between 0 and 255, inclusively.</li>
+ * <li>uint16 - represents integer values between 0 and 65535, inclusively.</li>
+ * <li>uint32 - represents integer values between 0 and 4294967295,
+      inclusively.</li>
+ * <li>uint64 - represents integer values between 0 and 18446744073709551615,
+      inclusively.</li>
+ * </ul>
+ *
+ */
+public abstract class AbstractUnsignedInteger implements
+        UnsignedIntegerTypeDefinition {
+    private final QName name;
+    private final SchemaPath path;
+    private final String description;
+    private final String reference = "https://tools.ietf.org/html/rfc6020#section-9.2";
+
+    private final String units;
+    private final List<RangeConstraint> rangeStatements;
+    
+    /**
+     * @param name
+     * @param description
+     * @param minRange
+     * @param maxRange
+     * @param units
+     */
+    public AbstractUnsignedInteger(final QName name, final String description,
+            final Number minRange, final Number maxRange, final String units) {
+        this.name = name;
+        this.description = description;
+        this.path = BaseTypes.schemaPath(name);
+        this.units = units;
+        this.rangeStatements = new ArrayList<RangeConstraint>();
+        final String rangeDescription = "Integer values between " + minRange
+                + " and " + maxRange + ", inclusively.";
+        this.rangeStatements.add(BaseConstraints.rangeConstraint(minRange,
+                maxRange, rangeDescription, "https://tools.ietf.org/html/rfc6020#section-9.2.4"));
+    }
+
+    /**
+     * @param name
+     * @param description
+     * @param rangeStatements
+     * @param units
+     */
+    public AbstractUnsignedInteger(final QName name, final String description,
+            final List<RangeConstraint> rangeStatements, final String units) {
+        this.name = name;
+        this.description = description;
+        this.path = BaseTypes.schemaPath(name);
+        this.units = units;
+        this.rangeStatements = rangeStatements;
+    }
+    
+    @Override
+    public String getUnits() {
+        return units;
+    }
+
+    @Override
+    public QName getQName() {
+        return name;
+    }
+
+    @Override
+    public SchemaPath getPath() {
+        return path;
+    }
+
+    @Override
+    public String getDescription() {
+        return description;
+    }
+
+    @Override
+    public String getReference() {
+        return reference;
+    }
+
+    @Override
+    public Status getStatus() {
+        return Status.CURRENT;
+    }
+
+    @Override
+    public List<RangeConstraint> getRangeStatements() {
+        return rangeStatements;
+    }
+
+    @Override
+    public List<UnknownSchemaNode> getUnknownSchemaNodes() {
+        return Collections.emptyList();
+    }
+
+    @Override
+    public int hashCode() {
+        final int prime = 31;
+        int result = 1;
+        result = prime * result
+                + ((description == null) ? 0 : description.hashCode());
+        result = prime * result + ((name == null) ? 0 : name.hashCode());
+        result = prime * result + ((path == null) ? 0 : path.hashCode());
+        result = prime * result
+                + ((rangeStatements == null) ? 0 : rangeStatements.hashCode());
+        result = prime * result
+                + ((reference == null) ? 0 : reference.hashCode());
+        result = prime * result + ((units == null) ? 0 : units.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;
+        }
+        AbstractUnsignedInteger other = (AbstractUnsignedInteger) obj;
+        if (description == null) {
+            if (other.description != null) {
+                return false;
+            }
+        } else if (!description.equals(other.description)) {
+            return false;
+        }
+        if (name == null) {
+            if (other.name != null) {
+                return false;
+            }
+        } else if (!name.equals(other.name)) {
+            return false;
+        }
+        if (path == null) {
+            if (other.path != null) {
+                return false;
+            }
+        } else if (!path.equals(other.path)) {
+            return false;
+        }
+        if (rangeStatements == null) {
+            if (other.rangeStatements != null) {
+                return false;
+            }
+        } else if (!rangeStatements.equals(other.rangeStatements)) {
+            return false;
+        }
+        if (reference == null) {
+            if (other.reference != null) {
+                return false;
+            }
+        } else if (!reference.equals(other.reference)) {
+            return false;
+        }
+        if (units == null) {
+            if (other.units != null) {
+                return false;
+            }
+        } else if (!units.equals(other.units)) {
+            return false;
+        }
+        return true;
+    }
+
+    @Override
+    public String toString() {
+        StringBuilder builder = new StringBuilder();
+        builder.append("AbstractInteger [name=");
+        builder.append(name);
+        builder.append(", path=");
+        builder.append(path);
+        builder.append(", description=");
+        builder.append(description);
+        builder.append(", reference=");
+        builder.append(reference);
+        builder.append(", units=");
+        builder.append(units);
+        builder.append(", rangeStatements=");
+        builder.append(rangeStatements);
+        builder.append("]");
+        return builder.toString();
+    }
+}