Populate model/ hierarchy

[yangtools.git] / model / yang-model-api / src / main / java / org / opendaylight / yangtools / yang / model / api / AugmentationSchemaNode.java

diff --git a/model/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/AugmentationSchemaNode.java b/model/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/AugmentationSchemaNode.java
new file mode 100644 (file)
index 0000000..ac44a33
--- /dev/null
+++ b/model/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/AugmentationSchemaNode.java
@@ -0,0 +1,43 @@
+/*
+ * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.opendaylight.yangtools.yang.model.api;
+
+import java.util.Optional;
+import org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus;
+import org.opendaylight.yangtools.yang.model.api.stmt.AugmentEffectiveStatement;
+import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
+
+/**
+ * AugmentationSchema represents augment definition. The "augment" statement allows a module or submodule to add
+ * to the schema tree defined in an external module, or the current module and its submodules, and to add to the nodes
+ * from a grouping in a "uses" statement.
+ */
+public interface AugmentationSchemaNode extends DataNodeContainer, NotificationNodeContainer, ActionNodeContainer,
+        WhenConditionAware, WithStatus, EffectiveStatementEquivalent<AugmentEffectiveStatement> {
+    /**
+     * Returns augmentation schema path.
+     *
+     * @return SchemaNodeIdentifier that identifies a node in the schema tree. This node
+     *         is called the augment's target node. The target node MUST be
+     *         either a container, list, choice, case, input, output, or
+     *         notification node. It is augmented with the nodes defined as
+     *         child nodes of this AugmentationSchema.
+     */
+    default SchemaNodeIdentifier getTargetPath() {
+        return asEffectiveStatement().argument();
+    }
+
+    /**
+     * Returns Augmentation Definition from which this augmentation is derived
+     * if augmentation was added transitively via augmented uses.
+     *
+     * @return Augmentation Definition from which this augmentation is derived
+     *         if augmentation was added transitively via augmented uses.
+     */
+    Optional<AugmentationSchemaNode> getOriginalDefinition();
+}