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

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.yangtools.yang.model.api;
   9
  10 import java.util.Map;
  11 import java.util.Optional;
  12 import java.util.Set;
  13 import javax.annotation.Nonnull;
  14
  15 /**
  16  * Contains the methods for getting data and checking properties of the YANG
  17  * <code>uses</code> substatement.
  18  */
  19 public interface UsesNode extends DocumentedNode.WithStatus {
  20
  21     /**
  22      * Returns the schema path to used grouping.
  23      *
  24      * @return schema path to 'grouping' on which this 'uses' statement points
  25      */
  26     @Nonnull SchemaPath getGroupingPath();
  27
  28     /**
  29      * Returns augmentations which were specified in this uses node.
  30      *
  31      * @return Set of augment statements defined under this uses node
  32      */
  33     @Nonnull Set<AugmentationSchema> getAugmentations();
  34
  35     /**
  36      * Returns <code>true</code> if the data node was added by augmentation,
  37      * otherwise returns <code>false</code>.
  38      *
  39      * @return <code>true</code> if the data node was added by augmentation,
  40      *         otherwise returns <code>false</code>
  41      */
  42     boolean isAugmenting();
  43
  44     /**
  45      * Returns <code>true</code> if the data node was added by uses statement,
  46      * otherwise returns <code>false</code>.
  47      *
  48      * @return <code>true</code> if the data node was added by uses statement,
  49      *         otherwise returns <code>false</code>
  50      */
  51     boolean isAddedByUses();
  52
  53     /**
  54      * Some of the properties of each node in the grouping can be refined with
  55      * the "refine" statement.
  56      *
  57      * @return Map, where key is schema path of refined node and value is
  58      *         refined node
  59      */
  60     @Nonnull Map<SchemaPath, SchemaNode> getRefines();
  61
  62     /**
  63      * Returns when statement.
  64      *
  65      * <p>
  66      * If when condition is present node defined by the parent data definition
  67      * statement is only valid when the returned XPath expression conceptually
  68      * evaluates to "true" for a particular instance, then the node defined by
  69      * the parent data definition statement is valid; otherwise, it is not.
  70      *
  71      * @return Optional of XPath condition
  72      */
  73     default @Nonnull Optional<RevisionAwareXPath> getWhenCondition() {
  74         return Optional.empty();
  75     }
  76 }