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 {
  20
  21     /**
  22      * Returns when statement
  23      *
  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      * @return textual description of this augment.
  36      */
  37     String getDescription();
  38
  39     /**
  40      * @return textual cross-reference to an external document that provides
  41      *         additional information relevant to this node.
  42      */
  43     String getReference();
  44
  45     /**
  46      * @return actual status of this node.
  47      */
  48     Status getStatus();
  49
  50     /**
  51      * @return SchemaPath that identifies a node in the schema tree. This node
  52      *         is called the augment's target node. The target node MUST be
  53      *         either a container, list, choice, case, input, output, or
  54      *         notification node. It is augmented with the nodes defined as
  55      *         child nodes of this AugmentationSchema.
  56      */
  57     SchemaPath getTargetPath();
  58
  59     /**
  60      * @return collection of all unknown nodes defined in this augmentation
  61      */
  62     List<UnknownSchemaNode> getUnknownSchemaNodes();
  63
  64     /**
  65      * Returns Augmentation Definition from which this augmentation is derived
  66      * if augmentation was added transitively via augmented uses.
  67      *
  68      * @return Augmentation Definition from which this augmentation is derived
  69      *         if augmentation was added transitively via augmented uses.
  70      */
  71     Optional<AugmentationSchema> getOriginalDefinition();
  72
  73 }