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

diff --git a/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/model/api/type/LengthConstraint.java b/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/model/api/type/LengthConstraint.java
index 8c9cb79ad06a059bdb75fc6a6b9f2267f112b4f0..97f4448f57cde5c347616aa90afd88342bd32139 100644 (file)
--- a/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/model/api/type/LengthConstraint.java
+++ b/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/model/api/type/LengthConstraint.java
@@ -9,9 +9,42 @@ 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 Lenght Constraint 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
+ * Length-restricting values MUST NOT be negative. A length value is a\r
+ * non-negative integer, or one of the special values <code>min</code> or\r
+ * <code>max</code>. The defined <code>min</code> and <code>max</code> mean the\r
+ * minimum and maximum length accepted for the type being restricted,\r
+ * respectively. <br>\r
+ * An implementation is not required to support a length value larger than\r
+ * {@link Long#MAX_VALUE} <br>\r
+ * <br>\r
+ * The interface extends definitions from {@link ConstraintMetaDefinition} <br>\r
+ * <br>\r
+ * This interface was modeled according to definition in <a\r
+ * href="https://tools.ietf.org/html/rfc6020#section-9.4.4">[RFC-6020] The\r
+ * length Statement</a>.\r
+ * \r
+ * @see ConstraintMetaDefinition\r
+ */\r

 public interface LengthConstraint extends ConstraintMetaDefinition {\r
 \r
 public interface LengthConstraint extends ConstraintMetaDefinition {\r
 \r

+    /**\r
+     * Returns the length-restricting lower bound value. <br>\r
+     * The value MUST NOT be negative.\r
+     * \r
+     * @return the length-restricting lower bound value.\r
+     */\r

     Long getMin();\r
 \r
     Long getMin();\r
 \r

+    /**\r
+     * Returns the length-restricting upper bound value. <br>\r
+     * The value MUST NOT be negative.\r
+     * \r
+     * @return length-restricting upper bound value.\r
+     */\r

     Long getMax();\r
 }\r
     Long getMax();\r
 }\r