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 org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus;
  11 import org.opendaylight.yangtools.yang.model.api.stmt.AugmentEffectiveStatement;
  12 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
  13
  14 /**
  15  * AugmentationSchema represents augment definition. The "augment" statement allows a module or submodule to add
  16  * to the schema tree defined in an external module, or the current module and its submodules, and to add to the nodes
  17  * from a grouping in a "uses" statement.
  18  */
  19 public interface AugmentationSchemaNode extends DataNodeContainer, NotificationNodeContainer, ActionNodeContainer,
  20         WhenConditionAware, WithStatus, EffectiveStatementEquivalent<AugmentEffectiveStatement> {
  21     /**
  22      * Returns augmentation target path.
  23      *
  24      * @return SchemaNodeIdentifier that identifies a node in the schema tree. This node is called the augment's target
  25      *         node. The target node MUST be either a container, list, choice, case, input, output, or anotification
  26      *         node. It is augmented with the nodes defined as child nodes of this AugmentationSchema.
  27      */
  28     default SchemaNodeIdentifier getTargetPath() {
  29         return asEffectiveStatement().argument();
  30     }
  31 }