model/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/AugmentationSchemaNode.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.Optional;
  11 import org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus;
  12 import org.opendaylight.yangtools.yang.model.api.stmt.AugmentEffectiveStatement;
  13 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
  14
  15 /**
  16  * AugmentationSchema represents augment definition. The "augment" statement allows a module or submodule to add
  17  * to the schema tree defined in an external module, or the current module and its submodules, and to add to the nodes
  18  * from a grouping in a "uses" statement.
  19  */
  20 public interface AugmentationSchemaNode extends DataNodeContainer, NotificationNodeContainer, ActionNodeContainer,
  21         WhenConditionAware, WithStatus, EffectiveStatementEquivalent<AugmentEffectiveStatement> {
  22     /**
  23      * Returns augmentation target path.
  24      *
  25      * @return SchemaNodeIdentifier that identifies a node in the schema tree. This node is called the augment's target
  26      *         node. The target node MUST be either a container, list, choice, case, input, output, or anotification
  27      *         node. It is augmented with the nodes defined as child nodes of this AugmentationSchema.
  28      */
  29     default SchemaNodeIdentifier getTargetPath() {
  30         return asEffectiveStatement().argument();
  31     }
  32
  33     /**
  34      * Returns Augmentation Definition from which this augmentation is derived if augmentation was added transitively
  35      * via augmented uses.
  36      *
  37      * @return Augmentation Definition from which this augmentation is derived if augmentation was added transitively
  38      *         via augmented uses.
  39      * @deprecated This method has only a single user, who should be able to do without it.
  40      */
  41     @Deprecated(since = "7.0.9", forRemoval = true)
  42     Optional<AugmentationSchemaNode> getOriginalDefinition();
  43 }