Updated YANG Type definitions and documentation in YANG Model Utils.
[controller.git] / opendaylight / sal / yang-prototype / yang / yang-model-util / src / main / java / org / opendaylight / controller / model / util / AbstractSignedInteger.java
-/*\r
- * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.\r
- *\r
- * This program and the accompanying materials are made available under the\r
- * terms of the Eclipse Public License v1.0 which accompanies this distribution,\r
- * and is available at http://www.eclipse.org/legal/epl-v10.html\r
- */\r
-package org.opendaylight.controller.model.util;\r
-\r
-import java.util.Collections;\r
-import java.util.List;\r
-\r
-import org.opendaylight.controller.model.api.type.IntegerTypeDefinition;\r
-import org.opendaylight.controller.model.api.type.RangeConstraint;\r
-import org.opendaylight.controller.yang.common.QName;\r
-import org.opendaylight.controller.yang.model.api.SchemaPath;\r
-import org.opendaylight.controller.yang.model.api.Status;\r
-import org.opendaylight.controller.yang.model.api.UnknownSchemaNode;\r
-\r
-public abstract class AbstractInteger implements IntegerTypeDefinition {\r
-\r
-    private final QName name;\r
-    private final SchemaPath path;\r
-\r
-    private final String description;\r
-    private final String reference;\r
-\r
-    private String units = "";\r
-    private final List<RangeConstraint> rangeStatements;\r
-\r
-    public AbstractInteger(final QName name, final String description,\r
-            final String reference) {\r
-        super();\r
-        this.name = name;\r
-        this.description = description;\r
-        this.reference = reference;\r
-        this.path = BaseTypes.schemaPath(name);\r
-\r
-        final List<? extends RangeConstraint> emptyContstraints = Collections\r
-                .emptyList();\r
-        this.rangeStatements = Collections.unmodifiableList(emptyContstraints);\r
-    }\r
-\r
-    public AbstractInteger(QName name, String description, String reference,\r
-            List<RangeConstraint> rangeStatements) {\r
-        super();\r
-        this.name = name;\r
-        this.description = description;\r
-        this.reference = reference;\r
-        this.rangeStatements = rangeStatements;\r
-        this.path = BaseTypes.schemaPath(name);\r
-    }\r
-\r
-    public AbstractInteger(QName name, String description, String reference,\r
-            String units) {\r
-        super();\r
-        this.name = name;\r
-        this.description = description;\r
-        this.reference = reference;\r
-        this.units = units;\r
-        this.path = BaseTypes.schemaPath(name);\r
-\r
-        final List<? extends RangeConstraint> emptyContstraints = Collections\r
-                .emptyList();\r
-        this.rangeStatements = Collections.unmodifiableList(emptyContstraints);\r
-    }\r
-\r
-    public AbstractInteger(QName name, String description, String reference,\r
-            String units, List<RangeConstraint> rangeStatements) {\r
-        super();\r
-        this.name = name;\r
-        this.description = description;\r
-        this.reference = reference;\r
-        this.units = units;\r
-        this.rangeStatements = rangeStatements;\r
-        this.path = BaseTypes.schemaPath(name);\r
-    }\r
-\r
-    @Override\r
-    public String getUnits() {\r
-        return units;\r
-    }\r
-\r
-    @Override\r
-    public QName getQName() {\r
-        return name;\r
-    }\r
-\r
-    @Override\r
-    public SchemaPath getPath() {\r
-        return path;\r
-    }\r
-\r
-    @Override\r
-    public String getDescription() {\r
-        return description;\r
-    }\r
-\r
-    @Override\r
-    public String getReference() {\r
-        return reference;\r
-    }\r
-\r
-    @Override\r
-    public Status getStatus() {\r
-        return Status.CURRENT;\r
-    }\r
-\r
-    @Override\r
-    public List<RangeConstraint> getRangeStatements() {\r
-        return rangeStatements;\r
-    }\r
-\r
-    @Override\r
-    public List<UnknownSchemaNode> getUnknownSchemaNodes() {\r
-        return Collections.emptyList();\r
-    }\r
-\r
-    @Override\r
-    public int hashCode() {\r
-        final int prime = 31;\r
-        int result = 1;\r
-        result = prime * result\r
-                + ((description == null) ? 0 : description.hashCode());\r
-        result = prime * result + ((name == null) ? 0 : name.hashCode());\r
-        result = prime * result + ((path == null) ? 0 : path.hashCode());\r
-        result = prime * result\r
-                + ((rangeStatements == null) ? 0 : rangeStatements.hashCode());\r
-        result = prime * result\r
-                + ((reference == null) ? 0 : reference.hashCode());\r
-        result = prime * result + ((units == null) ? 0 : units.hashCode());\r
-        return result;\r
-    }\r
-\r
-    @Override\r
-    public boolean equals(Object obj) {\r
-        if (this == obj) {\r
-            return true;\r
-        }\r
-        if (obj == null) {\r
-            return false;\r
-        }\r
-        if (getClass() != obj.getClass()) {\r
-            return false;\r
-        }\r
-        AbstractInteger other = (AbstractInteger) obj;\r
-        if (description == null) {\r
-            if (other.description != null) {\r
-                return false;\r
-            }\r
-        } else if (!description.equals(other.description)) {\r
-            return false;\r
-        }\r
-        if (name == null) {\r
-            if (other.name != null) {\r
-                return false;\r
-            }\r
-        } else if (!name.equals(other.name)) {\r
-            return false;\r
-        }\r
-        if (path == null) {\r
-            if (other.path != null) {\r
-                return false;\r
-            }\r
-        } else if (!path.equals(other.path)) {\r
-            return false;\r
-        }\r
-        if (rangeStatements == null) {\r
-            if (other.rangeStatements != null) {\r
-                return false;\r
-            }\r
-        } else if (!rangeStatements.equals(other.rangeStatements)) {\r
-            return false;\r
-        }\r
-        if (reference == null) {\r
-            if (other.reference != null) {\r
-                return false;\r
-            }\r
-        } else if (!reference.equals(other.reference)) {\r
-            return false;\r
-        }\r
-        if (units == null) {\r
-            if (other.units != null) {\r
-                return false;\r
-            }\r
-        } else if (!units.equals(other.units)) {\r
-            return false;\r
-        }\r
-        return true;\r
-    }\r
-\r
-    @Override\r
-    public String toString() {\r
-        StringBuilder builder = new StringBuilder();\r
-        builder.append("AbstractInteger [name=");\r
-        builder.append(name);\r
-        builder.append(", path=");\r
-        builder.append(path);\r
-        builder.append(", description=");\r
-        builder.append(description);\r
-        builder.append(", reference=");\r
-        builder.append(reference);\r
-        builder.append(", units=");\r
-        builder.append(units);\r
-        builder.append(", rangeStatements=");\r
-        builder.append(rangeStatements);\r
-        builder.append("]");\r
-        return builder.toString();\r
-    }\r
-}\r
+/*
+ * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.opendaylight.controller.model.util;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+
+import org.opendaylight.controller.model.api.type.IntegerTypeDefinition;
+import org.opendaylight.controller.model.api.type.RangeConstraint;
+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;
+
+/**
+ * The Abstract Integer class defines implementation of IntegerTypeDefinition
+ * interface which represents SIGNED Integer values defined in Yang language. <br>
+ * The integer built-in types in Yang are int8, int16, int32, int64. They
+ * represent signed integers of different sizes:
+ * 
+ * <ul>
+ * <li>int8 - represents integer values between -128 and 127, inclusively.</li>
+ * <li>int16 - represents integer values between -32768 and 32767, inclusively.</li>
+ * <li>int32 - represents integer values between -2147483648 and 2147483647,
+ * inclusively.</li>
+ * <li>int64 - represents integer values between -9223372036854775808 and
+ * 9223372036854775807, inclusively.</li>
+ * </ul>
+ * 
+ */
+public abstract class AbstractSignedInteger implements IntegerTypeDefinition {
+
+    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 AbstractSignedInteger(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 AbstractSignedInteger(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;
+        }
+        AbstractSignedInteger other = (AbstractSignedInteger) 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();
+    }
+}