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 / RangeConstraint.java

diff --git a/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/model/api/type/RangeConstraint.java b/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/model/api/type/RangeConstraint.java
index 76bfb75301d4358afcd1537fc1dbfec38d6a68d7..12fbb1bcd5728e3ee96b53fdaaa7a6c0384eac98 100644 (file)
--- a/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/model/api/type/RangeConstraint.java
+++ b/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/model/api/type/RangeConstraint.java
@@ -9,9 +9,37 @@ package org.opendaylight.controller.model.api.type;
 \r
 import org.opendaylight.controller.yang.model.api.ConstraintMetaDefinition;\r
 \r
 \r
 import org.opendaylight.controller.yang.model.api.ConstraintMetaDefinition;\r
 \r

+/**\r
+ * The Range Constraint interface is used to restrict integer and decimal\r
+ * built-in types, or types derived from those.\r
+ * <br>\r
+ * A range consists of an explicit value consists of an explicit value, or a lower bound\r
+ * returned by {@link #getMin()} and an upper bound returned by\r
+ * {@link #getMax()}. <br>\r
+ * <br>\r
+ * Each explicit value and range boundary value given in\r
+ * the range expression MUST match the type being restricted, or be one of the\r
+ * special values "min" or "max". "min" and "max" mean the minimum and maximum\r
+ * value accepted for the type being restricted, respectively\r
+ * <br>\r
+ * <br>\r
+ * This interface was modeled according to definition in <a\r
+ * href="https://tools.ietf.org/html/rfc6020#section-9.2.4">[RFC-6020] The\r
+ * range Statement</a>.\r
+ */\r

 public interface RangeConstraint extends ConstraintMetaDefinition {\r
 \r
 public interface RangeConstraint extends ConstraintMetaDefinition {\r
 \r

-    Long getMin();\r
+    /**\r
+     * Returns the length-restricting lower bound value.\r
+     * \r
+     * @return the length-restricting lower bound value.\r
+     */\r
+    Number getMin();\r

 \r
 \r

-    Long getMax();\r
+    /**\r
+     * Returns the length-restricting upper bound value.\r
+     * \r
+     * @return the length-restricting upper bound value.\r
+     */\r
+    Number getMax();\r

 }\r
 }\r