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

diff --git a/opendaylight/sal/yang-prototype/yang/yang-model-util/src/main/java/org/opendaylight/controller/model/util/BitsType.java b/opendaylight/sal/yang-prototype/yang/yang-model-util/src/main/java/org/opendaylight/controller/model/util/BitsType.java
index b783bc773090e76d56c197797d30f33d5fdd1c9b..ac7bcaab9653e6367f06ab41178e0b45f543ac1d 100644 (file)
--- a/opendaylight/sal/yang-prototype/yang/yang-model-util/src/main/java/org/opendaylight/controller/model/util/BitsType.java
+++ b/opendaylight/sal/yang-prototype/yang/yang-model-util/src/main/java/org/opendaylight/controller/model/util/BitsType.java
@@ -16,12 +16,21 @@ import org.opendaylight.controller.yang.model.api.SchemaPath;
 import org.opendaylight.controller.yang.model.api.Status;\r
 import org.opendaylight.controller.yang.model.api.UnknownSchemaNode;\r
 \r
+\r
+/**\r
+ * The <code>default</code> implementation of Bits Type Definition interface.\r
+ * \r
+ * @see BitsTypeDefinition\r
+ */\r
 public class BitsType implements BitsTypeDefinition {\r
 \r
     private final QName name = BaseTypes.constructQName("bits");\r
     private final SchemaPath path = BaseTypes.schemaPath(name);\r
-    private final String description = "";\r
-    private final String reference = "";\r
+    private final String description = "The bits built-in type represents a bit set.  " +\r
+               "That is, a bits value is a set of flags identified by small integer position " +\r
+               "numbers starting at 0.  Each bit number has an assigned name.";\r
+    \r
+    private final String reference = "https://tools.ietf.org/html/rfc6020#section-9.7";\r
 \r
     private final List<Bit> bits;\r
     private String units = "";\r
@@ -29,7 +38,6 @@ public class BitsType implements BitsTypeDefinition {
     /**\r
      * Default constructor. <br>\r
      * Instantiates Bits type as empty bits list.\r
-     * \r
      */\r
     public BitsType() {\r
         super();\r
@@ -37,7 +45,7 @@ public class BitsType implements BitsTypeDefinition {
     }\r
 \r
     /**\r
-     * Overloaded constructor with explicit definition of bits assigned to\r
+     * Constructor with explicit definition of bits assigned to\r
      * BitsType.\r
      * \r
      * @param bits\r
@@ -49,10 +57,18 @@ public class BitsType implements BitsTypeDefinition {
         this.units = "";\r
     }\r
 \r
+    /**\r
+     * Constructor with explicit definition of bits assigned to\r
+     * BitsType and Units.\r
+     * <br>\r
+     * The default value of Bits Type is List of bits.\r
+     * \r
+     * @param bits The bits assigned for Bits Type\r
+     * @param units units for bits type\r
+     */\r
     public BitsType(List<Bit> bits, String units) {\r
         super();\r
         this.bits = Collections.unmodifiableList(bits);\r
-        ;\r
         this.units = units;\r
     }\r
 \r