API Clarity: Documented o.o.y.yang.parser.builder.api

[yangtools.git] / yang / yang-parser-impl / src / main / java / org / opendaylight / yangtools / yang / parser / builder / api / GroupingBuilder.java

diff --git a/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/builder/api/GroupingBuilder.java b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/builder/api/GroupingBuilder.java
index b79f68a505f5ce106c955f45a51271149327a8fa..fb7b9c8d61739c909c37cee6092b65688bab8b82 100644 (file)
--- a/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/builder/api/GroupingBuilder.java
+++ b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/builder/api/GroupingBuilder.java
@@ -19,15 +19,75 @@ public interface GroupingBuilder extends DataNodeContainerBuilder, SchemaNodeBui
 
     /**
      * Build GroupingDefinition object from this builder.
+     *
+     * @return Instance of {@link GroupingDefinition} described by this builder.
      */
+    @Override
     GroupingDefinition build();
 
+    /**
+     *
+     * Returns instantiation of grouping child nodes under supplied builder.
+     *
+     * Supplied newParent is not modified.
+     *
+     * For each {@link #getChildNodeBuilders()} new builder is created,
+     * which has supplied new parent set as their {@link Builder#getParent()}
+     * and QNames have updated namespace and revision per supplied parent
+     * node.
+     *
+     * @param newParent Parent node, under which this grouping should be instantiated.
+     * @return Set of new builders representing instantiation of this grouping.
+     */
     Set<DataSchemaNodeBuilder> instantiateChildNodes(Builder newParent);
 
+
+   /**
+    *
+    * Returns instantiation of grouping type definitions under supplied builder.
+    *
+    * Supplied newParent is not modified.
+    *
+    * For each {@link #getTypeDefinitionBuilders()} new builder is created,
+    * which has supplied new parent set as their {@link Builder#getParent()}
+    * and QNames have updated namespace and revision per supplied parent
+    * node.
+    *
+    * @param newParent Parent node, under which this grouping should be instantiated.
+    * @return Set of new builders representing instantiation of this grouping.
+    */
     Set<TypeDefinitionBuilder> instantiateTypedefs(Builder newParent);
 
+   /**
+    *
+    * Returns instantiation of grouping definitions under supplied builder.
+    *
+    * Supplied newParent is not modified.
+    *
+    * For each {@link #getGroupingBuilders()} new builder is created,
+    * which has supplied new parent set as their {@link Builder#getParent()}
+    * and QNames have updated namespace and revision per supplied parent
+    * node.
+    *
+    * @param newParent Parent node, under which this grouping should be instantiated.
+    * @return Set of new builders representing instantiation of this grouping.
+    */
     Set<GroupingBuilder> instantiateGroupings(Builder newParent);
 
+    /**
+    *
+    * Returns instantiation of unknown nodes under supplied builder.
+    *
+    * Supplied newParent is not modified.
+    *
+    * For each {@link #getUnknownNodes()} new builder is created,
+    * which has supplied new parent set as their {@link Builder#getParent()}
+    * and QNames have updated namespace and revision per supplied parent
+    * node.
+    *
+    * @param newParent Parent node, under which this grouping should be instantiated.
+    * @return Set of new builders representing instantiation of this grouping.
+    */
     Set<UnknownSchemaNodeBuilder> instantiateUnknownNodes(Builder newParent);
 
 }