BUG-865: deprecate pre-Beryllium parser elements

[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 1699da75abf9d9516cf156d9bbe0fd8d33f934be..c6dcc41f553d5d6248e83c50d6c3eab1e029ec52 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
@@ -12,20 +12,21 @@ import org.opendaylight.yangtools.yang.model.api.SchemaPath;
 
 /**
  * Builder for {@link AugmentationSchema}, which represents 'augment' statement.
+ *
+ * @deprecated Pre-Beryllium implementation, scheduled for removal.
  */
+@Deprecated
 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.
-     *
+     * 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
+     * @return when condition as string
      */
     String getWhenCondition();
 
@@ -38,7 +39,7 @@ public interface AugmentationSchemaBuilder extends DataNodeContainerBuilder,Docu
      * for a particular instance, then the node defined by the parent data
      * definition statement is valid; otherwise, it is not.
      *
-     * @param whenCondition
+     * @param whenCondition string representation of when condition
      */
     void addWhenCondition(String whenCondition);
 
@@ -74,7 +75,7 @@ public interface AugmentationSchemaBuilder extends DataNodeContainerBuilder,Docu
     /**
      * Set information about augmentation process.
      *
-     * @param resolved
+     * @param resolved information about augmentation process
      */
     void setResolved(boolean resolved);
 
@@ -87,4 +88,19 @@ public interface AugmentationSchemaBuilder extends DataNodeContainerBuilder,Docu
      */
     int getOrder();
 
+    /**
+     *  Set true if target of augment is unsupported (e.g. node in body of extension).
+     *  In such case, augmentation is skipped and AugmentationSchema is not built.
+     *
+     *  @param unsupportedTarget information about target of augment statement
+     */
+    void setUnsupportedTarget(boolean unsupportedTarget);
+
+    /**
+     *  Return true if target of augment is unsupported (e.g. node in body of extension).
+     *  In such case, augmentation is skipped and AugmentationSchema is not built.
+     *
+     *  @return information about target of augment statement
+     */
+    boolean isUnsupportedTarget();
 }