2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.yang.model.api;
10 import java.util.Optional;
11 import org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus;
12 import org.opendaylight.yangtools.yang.model.api.stmt.AugmentEffectiveStatement;
13 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
16 * AugmentationSchema represents augment definition. The "augment" statement allows a module or submodule to add
17 * to the schema tree defined in an external module, or the current module and its submodules, and to add to the nodes
18 * from a grouping in a "uses" statement.
20 public interface AugmentationSchemaNode extends DataNodeContainer, NotificationNodeContainer, ActionNodeContainer,
21 WhenConditionAware, WithStatus, EffectiveStatementEquivalent<AugmentEffectiveStatement> {
23 * Returns augmentation schema path.
25 * @return SchemaNodeIdentifier that identifies a node in the schema tree. This node
26 * is called the augment's target node. The target node MUST be
27 * either a container, list, choice, case, input, output, or
28 * notification node. It is augmented with the nodes defined as
29 * child nodes of this AugmentationSchema.
31 default SchemaNodeIdentifier getTargetPath() {
32 return asEffectiveStatement().argument();
36 * Returns Augmentation Definition from which this augmentation is derived
37 * if augmentation was added transitively via augmented uses.
39 * @return Augmentation Definition from which this augmentation is derived
40 * if augmentation was added transitively via augmented uses.
42 Optional<AugmentationSchemaNode> getOriginalDefinition();