More javadocs added to yang-model-api.

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

diff --git a/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/ListSchemaNode.java b/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/ListSchemaNode.java
index 824afb76e8fe217e584c63bdaae0d4fd8cf5c2b9..3a812bd35e537cf32777b01a4c82949c61753da7 100644 (file)
--- a/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/ListSchemaNode.java
+++ b/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/ListSchemaNode.java
@@ -11,11 +11,29 @@ import java.util.List;
 \r
 import org.opendaylight.controller.yang.common.QName;\r
 \r
+/**\r
+ * Interface describing YANG 'list' statement.\r
+ * <p>\r
+ * The 'list' statement is used to define an interior data node in the schema\r
+ * tree. A list entry is uniquely identified by the values of the list's keys,\r
+ * if defined.\r
+ * </p>\r
+ */\r
 public interface ListSchemaNode extends DataNodeContainer, AugmentationTarget,\r
         DataSchemaNode {\r
 \r
+    /**\r
+     * @return List of QNames of leaf identifiers of this list\r
+     */\r
     public List<QName> getKeyDefinition();\r
 \r
+    /**\r
+     * YANG 'ordered-by' statement. It defines whether the order of entries\r
+     * within a list are determined by the user or the system. If not present,\r
+     * default is false.\r
+     *\r
+     * @return true if ordered-by argument is "user", false otherwise\r
+     */\r
     boolean isUserOrdered();\r
 \r
 }\r