X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=opendaylight%2Fsal%2Fyang-prototype%2Fyang%2Fyang-model-api%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fyang%2Fmodel%2Fapi%2FListSchemaNode.java;h=3a812bd35e537cf32777b01a4c82949c61753da7;hb=refs%2Fchanges%2F65%2F365%2F2;hp=824afb76e8fe217e584c63bdaae0d4fd8cf5c2b9;hpb=626c9943156ed658f0a4cf11858ccc19b9c316cf;p=controller.git

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 824afb76e8..3a812bd35e 100644
--- 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;
 
 import org.opendaylight.controller.yang.common.QName;
 
+/**
+ * Interface describing YANG 'list' statement.
+ * <p>
+ * The 'list' statement is used to define an interior data node in the schema
+ * tree. A list entry is uniquely identified by the values of the list's keys,
+ * if defined.
+ * </p>
+ */
 public interface ListSchemaNode extends DataNodeContainer, AugmentationTarget,
         DataSchemaNode {
 
+    /**
+     * @return List of QNames of leaf identifiers of this list
+     */
     public List<QName> getKeyDefinition();
 
+    /**
+     * YANG 'ordered-by' statement. It defines whether the order of entries
+     * within a list are determined by the user or the system. If not present,
+     * default is false.
+     *
+     * @return true if ordered-by argument is "user", false otherwise
+     */
     boolean isUserOrdered();
 
 }