Introduce WhenConditionAware
[yangtools.git] / yang / yang-model-api / src / main / java / org / opendaylight / yangtools / yang / model / api / UsesNode.java
index eb8b27a4317c5d0c54a1dfe4cccf5df9413857ba..b96d2b2bc0449e73e44eaa60cb36fece65980514 100644 (file)
@@ -7,35 +7,33 @@
  */
 package org.opendaylight.yangtools.yang.model.api;
 
-import com.google.common.base.Optional;
 import java.util.Map;
 import java.util.Set;
+import javax.annotation.Nonnull;
+import org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus;
 
 /**
- * Contains the methods for getting data and checking properties of the YANG
- * <code>uses</code> substatement.
- *
+ * Contains the methods for getting data and checking properties of the YANG <code>uses</code> substatement.
  */
-public interface UsesNode extends DocumentedNode {
+public interface UsesNode extends WhenConditionAware, WithStatus {
 
     /**
      * Returns the schema path to used grouping.
      *
      * @return schema path to 'grouping' on which this 'uses' statement points
      */
-    SchemaPath getGroupingPath();
+    @Nonnull SchemaPath getGroupingPath();
 
     /**
-     *
      * Returns augmentations which were specified in this uses node.
      *
      * @return Set of augment statements defined under this uses node
      */
-    Set<AugmentationSchema> getAugmentations();
+    @Nonnull Set<AugmentationSchemaNode> getAugmentations();
 
     /**
      * Returns <code>true</code> if the data node was added by augmentation,
-     * otherwise returns <code>false</code>
+     * otherwise returns <code>false</code>.
      *
      * @return <code>true</code> if the data node was added by augmentation,
      *         otherwise returns <code>false</code>
@@ -44,7 +42,7 @@ public interface UsesNode extends DocumentedNode {
 
     /**
      * Returns <code>true</code> if the data node was added by uses statement,
-     * otherwise returns <code>false</code>
+     * otherwise returns <code>false</code>.
      *
      * @return <code>true</code> if the data node was added by uses statement,
      *         otherwise returns <code>false</code>
@@ -58,19 +56,5 @@ public interface UsesNode extends DocumentedNode {
      * @return Map, where key is schema path of refined node and value is
      *         refined node
      */
-    Map<SchemaPath, SchemaNode> getRefines();
-
-    /**
-     * Returns when statement
-     *
-     * 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 Optional of XPath condition
-     */
-    default Optional<RevisionAwareXPath> getWhenCondition() {
-        return Optional.absent();
-    }
+    @Nonnull Map<SchemaPath, SchemaNode> getRefines();
 }