data/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/AugmentationNode.java

   1 /*
   2  * Copyright (c) 2014 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.data.api.schema;
   9
  10 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
  11 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
  12
  13 /**
  14  * Data instance of <code>augment</code> associated with parent node.
  15  *
  16  * <p>
  17  * Augmentation is addition of subtree defined by other external YANG Model and is schema for subtree is described
  18  * by an instance of {@link AugmentationSchemaNode} associated with parent node of this node.
  19  *
  20  * <p>
  21  * Augmentation node MUST NOT be direct child of other augmentation node.
  22  */
  23 public interface AugmentationNode extends DataContainerNode, DataContainerChild, MixinNode {
  24     @Override
  25     default Class<AugmentationNode> contract() {
  26         return AugmentationNode.class;
  27     }
  28
  29     /**
  30      * Gets identifier of augmentation node. Returned identifier of augmentation node contains all possible
  31      * direct child QNames.
  32      *
  33      * <p>
  34      * This is sufficient to identify instance of augmentation, since RFC6020 states that <code>augment</code>
  35      * that augment statement must not add multiple nodes from same namespace / module to the target node.
  36      *
  37      * @return Identifier which uniquely identifies augmentation in particular subtree.
  38      */
  39     @Override
  40     AugmentationIdentifier getIdentifier();
  41 }