model/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 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Descendant;
  15 import org.opendaylight.yangtools.yang.model.api.stmt.UsesEffectiveStatement;
  16
  17 /**
  18  * Contains the methods for getting data and checking properties of the YANG <code>uses</code> substatement.
  19  */
  20 public interface UsesNode extends WhenConditionAware, WithStatus, CopyableNode,
  21         EffectiveStatementEquivalent<UsesEffectiveStatement> {
  22     /**
  23      * Returns the {code grouping} which this node acted upon.
  24      *
  25      * @return Source grouping
  26      */
  27     @NonNull GroupingDefinition getSourceGrouping();
  28
  29     /**
  30      * Returns augmentations which were specified in this uses node.
  31      *
  32      * @return Set of augment statements defined under this uses node
  33      */
  34     @NonNull Collection<? extends AugmentationSchemaNode> getAugmentations();
  35
  36     /**
  37      * Some of the properties of each node in the grouping can be refined with the "refine" statement.
  38      *
  39      * @return Map, where key is schema node identifier of refined node and value is refined node.
  40      */
  41     // FIXME: 7.0.0: expose only refined paths and let users deal with locating them
  42     @NonNull Map<Descendant, SchemaNode> getRefines();
  43 }