Added more javadocs.

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

diff --git a/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/builder/api/UsesNodeBuilder.java b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/builder/api/UsesNodeBuilder.java
index a861c45f62d56d5955a145e60ffac4741756bf07..0ead00294692d2d31b1559b8cc3955587e1af9c8 100644 (file)
--- a/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/builder/api/UsesNodeBuilder.java
+++ b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/builder/api/UsesNodeBuilder.java
@@ -21,62 +21,186 @@ import org.opendaylight.yangtools.yang.parser.util.RefineHolder;
  */
 public interface UsesNodeBuilder extends GroupingMember, Builder {
 
+    /**
+     * Get parent of this uses node. Since uses can be defined only under on of
+     * module, container, list, case, grouping, input, output, notification or
+     * augment, return type is DataNodeContainerBuilder.
+     */
     DataNodeContainerBuilder getParent();
 
-    String getGroupingName();
-
+    /**
+     * Get grouping path as string.
+     *
+     * @return grouping path as String
+     */
+    String getGroupingPathAsString();
+
+    /**
+     * Get grouping path.
+     *
+     * @return grouping path as SchemaPath
+     */
     SchemaPath getGroupingPath();
 
+    /**
+     * Get grouping definition.
+     *
+     * @return GroupingDefinition if present, null otherwise
+     */
     GroupingDefinition getGroupingDefinition();
 
+    /**
+     * Set grouping definition.
+     *
+     * @param groupingDefinition
+     *            GroupingDefinition object
+     */
     void setGroupingDefinition(GroupingDefinition groupingDefinition);
 
+    /**
+     * Get grouping builder.
+     *
+     * @return GroupingBuilder if present, null otherwise
+     */
     GroupingBuilder getGroupingBuilder();
 
+    /**
+     * Set grouping builder.
+     *
+     * @param grouping
+     *            GroupingBuilder object
+     */
     void setGrouping(GroupingBuilder grouping);
 
+    /**
+     * Get augmentations defined in this uses node.
+     *
+     * @return set of augmentations defined in this node
+     */
     Set<AugmentationSchemaBuilder> getAugmentations();
 
+    /**
+     * Add augment builder.
+     *
+     * @param builder
+     *            new builder of augment statement
+     */
     void addAugment(AugmentationSchemaBuilder builder);
 
-    boolean isAugmenting();
-
-    void setAugmenting(boolean augmenting);
-
+    /**
+     * Get refine statements.
+     *
+     * @return list of RefineHolder objects
+     */
     List<RefineHolder> getRefines();
 
+    /**
+     * Get refined nodes.
+     *
+     * @return List of refined SchemaNodeBuilder objects
+     */
     List<SchemaNodeBuilder> getRefineNodes();
 
+    /**
+     * Add refine statement.
+     *
+     * @param refine
+     *            new RefineHolder object
+     */
     void addRefine(RefineHolder refine);
 
+    /**
+     * Add refine node.
+     *
+     * @param refineNode
+     *            refined DataSchemaNodeBuilder object
+     */
     void addRefineNode(DataSchemaNodeBuilder refineNode);
 
+    /**
+     * Build new UsesNode object.
+     */
     UsesNode build();
 
+    /**
+     * Get child nodes defined in target grouping.
+     *
+     * @return set of DataSchemaNodeBuilder objects
+     */
     Set<DataSchemaNodeBuilder> getTargetChildren();
 
+    /**
+     * Set reference to target grouping child nodes.
+     *
+     * @param targetChildren
+     *            set of child nodes defined in target grouping
+     */
     void setTargetChildren(Set<DataSchemaNodeBuilder> targetChildren);
 
+    /**
+     * Get groupings defined in target grouping.
+     *
+     * @return set of GroupingBuilder objects
+     */
     Set<GroupingBuilder> getTargetGroupings();
 
+    /**
+     * Set reference to target grouping groupings.
+     *
+     * @param targetGroupings
+     *            set of groupings defined in target grouping
+     */
     void setTargetGroupings(Set<GroupingBuilder> targetGroupings);
 
+    /**
+     * Get type definitions defined in target grouping.
+     *
+     * @return set of typedefs defined in target grouping
+     */
     Set<TypeDefinitionBuilder> getTargetTypedefs();
 
+    /**
+     * Set reference to target grouping typedefs.
+     *
+     * @param targetTypedefs
+     *            set of typedefs defined in target grouping
+     */
     void setTargetTypedefs(Set<TypeDefinitionBuilder> targetTypedefs);
 
+    /**
+     * Get unknown nodes defined in target grouping.
+     *
+     * @return list of unknown nodes defined in target grouping
+     */
     List<UnknownSchemaNodeBuilder> getTargetUnknownNodes();
 
+    /**
+     * Set reference to target grouping unknown nodes.
+     *
+     * @param targetUnknownNodes
+     *            list of unknown nodes defined in target grouping.
+     */
     void setTargetUnknownNodes(List<UnknownSchemaNodeBuilder> targetUnknownNodes);
 
+    /**
+     *
+     * @return true, if this object was built based on another UsesNodeBuilder,
+     *         false otherwise
+     */
     boolean isCopy();
 
+    /**
+     *
+     * @return true, if target grouping objects was loaded already, false
+     *         otherwise
+     */
     boolean isDataCollected();
 
+    /**
+     * Set if target grouping objects was loaded already.
+     *
+     * @param dataCollected
+     */
     void setDataCollected(boolean dataCollected);
 
-    boolean isParentUpdated();
-
-    void setParentUpdated(boolean parentUpdated);
-
 }