BUG-6533: add immutable implementations of yang.model.api

[yangtools.git] / yang / yang-model-api / src / main / java / org / opendaylight / yangtools / yang / model / api / UsesNode.java

diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/UsesNode.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/UsesNode.java
index 8f783c1516f2a92c2cfcf06618bd3fea1bbee2bd..86acdf68e4b3853c54c5a970693cbedd53412314 100644 (file)
--- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/UsesNode.java
+++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/UsesNode.java
@@ -7,30 +7,31 @@
  */
 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;
 
 /**
  * Contains the methods for getting data and checking properties of the YANG
  * <code>uses</code> substatement.
- *
  */
-public interface UsesNode extends YangNode {
+public interface UsesNode extends DocumentedNode.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 agumentations which were specified in this uses node.
+     * Returns augmentations which were specified in this uses node.
      *
      * @return Set of augment statements defined under this uses node
      */
-    Set<AugmentationSchema> getAugmentations();
+    @Nonnull Set<AugmentationSchema> getAugmentations();
 
     /**
      * Returns <code>true</code> if the data node was added by augmentation,
@@ -57,5 +58,19 @@ public interface UsesNode extends YangNode {
      * @return Map, where key is schema path of refined node and value is
      *         refined node
      */
-    Map<SchemaPath, SchemaNode> getRefines();
+    @Nonnull 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 @Nonnull Optional<RevisionAwareXPath> getWhenCondition() {
+        return Optional.absent();
+    }
 }