2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.yang.model.api;
11 import java.util.Optional;
13 import javax.annotation.Nonnull;
16 * Contains the methods for getting data and checking properties of the YANG
17 * <code>uses</code> substatement.
19 public interface UsesNode extends DocumentedNode.WithStatus {
22 * Returns the schema path to used grouping.
24 * @return schema path to 'grouping' on which this 'uses' statement points
26 @Nonnull SchemaPath getGroupingPath();
29 * Returns augmentations which were specified in this uses node.
31 * @return Set of augment statements defined under this uses node
33 @Nonnull Set<AugmentationSchemaNode> getAugmentations();
36 * Returns <code>true</code> if the data node was added by augmentation,
37 * otherwise returns <code>false</code>.
39 * @return <code>true</code> if the data node was added by augmentation,
40 * otherwise returns <code>false</code>
42 boolean isAugmenting();
45 * Returns <code>true</code> if the data node was added by uses statement,
46 * otherwise returns <code>false</code>.
48 * @return <code>true</code> if the data node was added by uses statement,
49 * otherwise returns <code>false</code>
51 boolean isAddedByUses();
54 * Some of the properties of each node in the grouping can be refined with
55 * the "refine" statement.
57 * @return Map, where key is schema path of refined node and value is
60 @Nonnull Map<SchemaPath, SchemaNode> getRefines();
63 * Returns when statement.
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.
71 * @return Optional of XPath condition
73 default @Nonnull Optional<RevisionAwareXPath> getWhenCondition() {
74 return Optional.empty();