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