Fixed tests. Added javadocs to yang-model-api.

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

diff --git a/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/DataNodeContainer.java b/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/DataNodeContainer.java
index 8888208cc287a0239952e57319d027b0a8eaf68b..e8c814e20804eadea4ec916ec834a4b3310c7e82 100644 (file)
--- a/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/DataNodeContainer.java
+++ b/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/DataNodeContainer.java
@@ -11,18 +11,45 @@ import java.util.Set;
 \r
 import org.opendaylight.controller.yang.common.QName;\r
 \r
+/**\r
+ * Node which can contains other nodes.\r
+ */\r
 public interface DataNodeContainer {\r
 \r
+    /**\r
+     * @return Set of all newly defined types within this DataNodeContainer\r
+     */\r
     Set<TypeDefinition<?>> getTypeDefinitions();\r
 \r
+    /**\r
+     * Set of all child nodes defined within this DataNodeContainer\r
+     */\r
     Set<DataSchemaNode> getChildNodes();\r
 \r
+    /**\r
+     * Set of all groupings defined within this DataNodeContainer\r
+     */\r
     Set<GroupingDefinition> getGroupings();\r
 \r
+    /**\r
+     * @param name\r
+     *            QName of seeked child\r
+     * @return child node of this DataNodeContainer if child with given name is\r
+     *         present, null otherwise\r
+     */\r
     DataSchemaNode getDataChildByName(QName name);\r
 \r
+    /**\r
+     * @param name\r
+     *            name of seeked child as String\r
+     * @return child node of this DataNodeContainer if child with given name is\r
+     *         present, null otherwise\r
+     */\r
     DataSchemaNode getDataChildByName(String name);\r
 \r
+    /**\r
+     * @return Set of all uses nodes defined within this DataNodeContainer\r
+     */\r
     Set<UsesNode> getUses();\r
 \r
 }\r