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