Moved parsing of unknown nodes from implementation to abstract classes.
[controller.git] / opendaylight / sal / yang-prototype / code-generator / yang-model-parser-impl / src / main / java / org / opendaylight / controller / yang / parser / builder / api / DataNodeContainerBuilder.java
index 4271776d63f4bca6dd11d5f1cff262abdfeebb55..7a5f80de9cd62546f3e72d8550a94bcecd0d8e40 100644 (file)
@@ -20,28 +20,90 @@ import org.opendaylight.controller.yang.model.api.SchemaPath;
  */
 public interface DataNodeContainerBuilder extends Builder {
 
+    /**
+     * Get qname of this node.
+     *
+     * @return QName of this node
+     */
     QName getQName();
 
+    /**
+     * Get schema path of this node.
+     *
+     * @return SchemaPath of this node
+     */
     SchemaPath getPath();
 
+    /**
+     * Get already built child nodes.
+     *
+     * @return collection of child nodes
+     */
     Set<DataSchemaNode> getChildNodes();
 
+    /**
+     * Get builders of child nodes.
+     *
+     * @return collection child nodes builders
+     */
     Set<DataSchemaNodeBuilder> getChildNodeBuilders();
 
+    /**
+     * Get child node by name.
+     *
+     * @param name
+     *            name of child to seek
+     * @return child node with given name if present, null otherwise
+     */
     DataSchemaNodeBuilder getDataChildByName(String name);
 
+    /**
+     * Add builder of child node to this node.
+     *
+     * @param childNode
+     */
     void addChildNode(DataSchemaNodeBuilder childNode);
 
+    /**
+     * Get already built groupings defined in this node.
+     *
+     * @return collection of GroupingDefinition objects
+     */
     Set<GroupingDefinition> getGroupings();
 
+    /**
+     * Get builders of groupings defined in this node.
+     *
+     * @return collection of grouping builders
+     */
     Set<GroupingBuilder> getGroupingBuilders();
 
+    /**
+     * Add builder of grouping statement to this node.
+     *
+     * @param groupingBuilder
+     */
     void addGrouping(GroupingBuilder groupingBuilder);
 
+    /**
+     * Add builder of uses statement to this node.
+     *
+     * @param usesBuilder
+     */
     void addUsesNode(UsesNodeBuilder usesBuilder);
 
+    /**
+     * Get builders of typedef statement defined in this node.
+     *
+     * @return
+     */
     Set<TypeDefinitionBuilder> getTypeDefinitionBuilders();
 
+    /**
+     * Add typedef builder to this node.
+     *
+     * @param typedefBuilder
+     */
     void addTypedef(TypeDefinitionBuilder typedefBuilder);
 
 }