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