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;
12 import javax.annotation.Nonnull;
13 import org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus;
16 * Contains the methods for getting data and checking properties of the YANG <code>uses</code> substatement.
18 public interface UsesNode extends WhenConditionAware, WithStatus {
21 * Returns the schema path to used grouping.
23 * @return schema path to 'grouping' on which this 'uses' statement points
25 @Nonnull SchemaPath getGroupingPath();
28 * Returns augmentations which were specified in this uses node.
30 * @return Set of augment statements defined under this uses node
32 @Nonnull Set<AugmentationSchemaNode> getAugmentations();
35 * Returns <code>true</code> if the data node was added by augmentation,
36 * otherwise returns <code>false</code>.
38 * @return <code>true</code> if the data node was added by augmentation,
39 * otherwise returns <code>false</code>
41 boolean isAugmenting();
44 * Returns <code>true</code> if the data node was added by uses statement,
45 * otherwise returns <code>false</code>.
47 * @return <code>true</code> if the data node was added by uses statement,
48 * otherwise returns <code>false</code>
50 boolean isAddedByUses();
53 * Some of the properties of each node in the grouping can be refined with
54 * the "refine" statement.
56 * @return Map, where key is schema path of refined node and value is
59 @Nonnull Map<SchemaPath, SchemaNode> getRefines();