Merge changes If1e9a750,Ib530560c,Id01393c3,I2d375382,Id60447ef,I350611fb,I0dbd80db

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

diff --git a/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/builder/api/AugmentationSchemaBuilder.java b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/builder/api/AugmentationSchemaBuilder.java
index 6b1e49e1ed1d954a2d53b13be978c454a416b2b2..f7004791e2c1d21da4fd77970c28438bfdd5f588 100644 (file)
--- a/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/builder/api/AugmentationSchemaBuilder.java
+++ b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/builder/api/AugmentationSchemaBuilder.java
@@ -9,31 +9,39 @@ package org.opendaylight.yangtools.yang.parser.builder.api;
 
 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
-import org.opendaylight.yangtools.yang.model.api.Status;
 
 /**
- * Interface for builders of 'augment' statement.
+ * Builder for {@link AugmentationSchema}, which represents 'augment' statement.
  */
-public interface AugmentationSchemaBuilder extends DataNodeContainerBuilder {
+public interface AugmentationSchemaBuilder extends DataNodeContainerBuilder,DocumentedNodeBuilder {
 
+    /**
+     * Returns when condition
+     *
+     * If when condition is present node defined by the parent data definition
+     * statement is only valid when the returned XPath expression conceptually
+     * evaluates to "true" for a particular instance, then the node defined by
+     * the parent data definition statement is valid; otherwise, it is not.
+     *
+     * @return when condition as string
+     */
     String getWhenCondition();
 
+    /**
+     * Adds string representation of when condition.
+     *
+     * If when condition is present node defined by the parent data definition
+     * statement is only valid when the returned XPath
+     * expression conceptually evaluates to "true"
+     * for a particular instance, then the node defined by the parent data
+     * definition statement is valid; otherwise, it is not.
+     *
+     * @param whenCondition
+     */
     void addWhenCondition(String whenCondition);
 
-    String getDescription();
-
-    void setDescription(String description);
-
-    String getReference();
-
-    void setReference(String reference);
-
-    Status getStatus();
-
-    void setStatus(Status status);
-
     /**
-     * Get path to target node as single string.
+     * Returns target path representation as was present in schema source.
      *
      * @return path to target node as String
      */
@@ -50,21 +58,7 @@ public interface AugmentationSchemaBuilder extends DataNodeContainerBuilder {
      */
     SchemaPath getTargetPath();
 
-    /**
-     * Get schema path of target node.
-     *
-     * @return SchemaPath of target node
-     */
-    SchemaPath getTargetNodeSchemaPath();
-
-    /**
-     * Set schema path of target node.
-     *
-     * @param path
-     *            SchemaPath of target node
-     */
-    void setTargetNodeSchemaPath(SchemaPath path);
-
+    @Override
     AugmentationSchema build();
 
     /**
@@ -82,6 +76,13 @@ public interface AugmentationSchemaBuilder extends DataNodeContainerBuilder {
      */
     void setResolved(boolean resolved);
 
+    /**
+     *
+     * Returns position of defining <code>augment</code> statement
+     * as was present in schema source.
+     *
+     * @return Position of definiing augment statement in source code.
+     */
     int getOrder();
 
 }