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.Collection;
  11 import java.util.Map;
  12 import org.eclipse.jdt.annotation.NonNull;
  13 import org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus;
  14
  15 /**
  16  * Contains the methods for getting data and checking properties of the YANG <code>uses</code> substatement.
  17  */
  18 public interface UsesNode extends WhenConditionAware, WithStatus, CopyableNode {
  19     /**
  20      * Returns the schema path to used grouping.
  21      *
  22      * @return schema path to 'grouping' on which this 'uses' statement points
  23      */
  24     // FIXME: 5.0.0: this is effective model, hence we should return GroupingDefinition
  25     @NonNull SchemaPath getGroupingPath();
  26
  27     /**
  28      * Returns augmentations which were specified in this uses node.
  29      *
  30      * @return Set of augment statements defined under this uses node
  31      */
  32     @NonNull Collection<? extends AugmentationSchemaNode> getAugmentations();
  33
  34     /**
  35      * Some of the properties of each node in the grouping can be refined with the "refine" statement.
  36      *
  37      * @return Map, where key is schema path of refined node and value is refined node
  38      */
  39     // FIXME: 5.0.0: this should probably be SchemaPath.RelativeSchemaPath (which needs to be exposed)
  40     @NonNull Map<SchemaPath, SchemaNode> getRefines();
  41 }