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