Added javadoc and RFC references to Java YANG model.

[controller.git] / opendaylight / sal / yang-prototype / yang / yang-model-api / src / main / java / org / opendaylight / controller / model / api / type / IntegerTypeDefinition.java

diff --git a/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/model/api/type/IntegerTypeDefinition.java b/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/model/api/type/IntegerTypeDefinition.java
index 92f3098a2371d27094d650684f4129e9943612f7..5b40c49f3e0fd2c8c964916acb94ecafa2c43958 100644 (file)
--- a/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/model/api/type/IntegerTypeDefinition.java
+++ b/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/model/api/type/IntegerTypeDefinition.java
@@ -11,8 +11,30 @@ import java.util.List;
 \r
 import org.opendaylight.controller.yang.model.api.TypeDefinition;\r
 \r
+/**\r
+ * IntegerTypeDefinition is interface which represents SIGNED Integer values\r
+ * defined in Yang language. <br>\r
+ * The integer built-in types in Yang are int8, int16, int32, int64. They\r
+ * represent signed integers of different sizes: <br>\r
+ * <ul>\r
+ * <li>int8 represents integer values between -128 and 127, inclusively.</li>\r
+ * <li>int16 represents integer values between -32768 and 32767, inclusively.</li>\r
+ * <li>int32 represents integer values between -2147483648 and 2147483647,\r
+ * inclusively.</li>\r
+ * <li>int64 represents integer values between -9223372036854775808 and\r
+ * 9223372036854775807, inclusively.</li>\r
+ * </ul>\r
+ * \r
+ * The Integer Built-In Types are defined in <a\r
+ * href="https://tools.ietf.org/html/rfc6020#section-9.2"> [RFC-6020]</a>\r
+ */\r
 public interface IntegerTypeDefinition extends\r
         TypeDefinition<IntegerTypeDefinition> {\r
 \r
+    /**\r
+     * Returns Range Constraints defined for given Integer Type.\r
+     * \r
+     * @return Range Constraints defined for given Integer Type.\r
+     */\r
     List<RangeConstraint> getRangeStatements();\r
 }\r