yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/AugmentationSchema.java

   1 /*
   2  * Copyright (c) 2013 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.model.api;
   9
  10 import com.google.common.base.Optional;
  11 import java.util.List;
  12
  13 /**
  14  * AugmentationSchema represents augment definition. The "augment" statement
  15  * allows a module or submodule to add to the schema tree defined in an external
  16  * module, or the current module and its submodules, and to add to the nodes
  17  * from a grouping in a "uses" statement.
  18  */
  19 public interface AugmentationSchema extends DataNodeContainer, NotificationNodeContainer, ActionNodeContainer {
  20     /**
  21      * Returns when statement.
  22      *
  23      * <p>
  24      * If when condition is present node defined by the parent data definition
  25      * statement is only valid when the returned XPath
  26      * expression conceptually evaluates to "true"
  27      * for a particular instance, then the node defined by the parent data
  28      * definition statement is valid; otherwise, it is not.
  29      *
  30      * @return XPath condition
  31      */
  32     RevisionAwareXPath getWhenCondition();
  33
  34     /**
  35      * Returns description text.
  36      *
  37      * @return textual description of this augment.
  38      */
  39     String getDescription();
  40
  41     /**
  42      * Returns reference text.
  43      *
  44      * @return textual cross-reference to an external document that provides
  45      *         additional information relevant to this node.
  46      */
  47     String getReference();
  48
  49     /**
  50      * Returns status of this node.
  51      *
  52      * @return actual status of this node.
  53      */
  54     Status getStatus();
  55
  56     /**
  57      * Returns augmentation schema path.
  58      *
  59      * @return SchemaPath that identifies a node in the schema tree. This node
  60      *         is called the augment's target node. The target node MUST be
  61      *         either a container, list, choice, case, input, output, or
  62      *         notification node. It is augmented with the nodes defined as
  63      *         child nodes of this AugmentationSchema.
  64      */
  65     SchemaPath getTargetPath();
  66
  67     /**
  68      * Returns unknown schema node children.
  69      *
  70      * @return collection of all unknown nodes defined in this augmentation
  71      */
  72     List<UnknownSchemaNode> getUnknownSchemaNodes();
  73
  74     /**
  75      * Returns Augmentation Definition from which this augmentation is derived
  76      * if augmentation was added transitively via augmented uses.
  77      *
  78      * @return Augmentation Definition from which this augmentation is derived
  79      *         if augmentation was added transitively via augmented uses.
  80      */
  81     Optional<AugmentationSchema> getOriginalDefinition();
  82
  83 }