Introduce WhenConditionAware
[yangtools.git] / yang / yang-model-api / src / main / java / org / opendaylight / yangtools / yang / model / api / UsesNode.java
index ae9aabae2bc32a34091fb3564af3dc4bfd9c98d6..b96d2b2bc0449e73e44eaa60cb36fece65980514 100644 (file)
@@ -9,33 +9,32 @@ package org.opendaylight.yangtools.yang.model.api;
 
 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 {
+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 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<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>
      */
@@ -43,8 +42,8 @@ public interface UsesNode {
 
     /**
      * 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>
      */
@@ -53,9 +52,9 @@ public interface UsesNode {
     /**
      * Some of the properties of each node in the grouping can be refined with
      * the "refine" statement.
-     * 
+     *
      * @return Map, where key is schema path of refined node and value is
      *         refined node
      */
-    Map<SchemaPath, SchemaNode> getRefines();
+    @Nonnull Map<SchemaPath, SchemaNode> getRefines();
 }