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

diff --git a/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/LeafListSchemaNode.java b/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/LeafListSchemaNode.java
index 1d7287f0f7333ad8f6cdf2eed15ea0cbf27f99c2..8780322e52fa691fc34919fff44fcfbd52a36407 100644 (file)
--- a/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/LeafListSchemaNode.java
+++ b/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/LeafListSchemaNode.java
@@ -7,10 +7,20 @@
  */\r
 package org.opendaylight.controller.yang.model.api;\r
 \r
+/**\r
+ * Interface describing YANG 'leaf-list' statement.\r
+ */\r
 public interface LeafListSchemaNode extends DataSchemaNode {\r
 \r
     TypeDefinition<? extends TypeDefinition<?>> getType();\r
 \r
+    /**\r
+     * YANG 'ordered-by' statement. It defines whether the order of entries\r
+     * within this leaf-list are determined by the user or the system. If not\r
+     * present, default is false.\r
+     *\r
+     * @return true if ordered-by argument is "user", false otherwise\r
+     */\r
     boolean isUserOrdered();\r
 \r
 }\r