org.opendaylight.yangtools.yang.model.api

Interface AugmentationSchema

All Superinterfaces:

ActionNodeContainer, DataNodeContainer, NotificationNodeContainer

All Known Implementing Classes:

AugmentEffectiveStatementImpl, EffectiveAugmentationSchema

public interface AugmentationSchema
extends DataNodeContainer, NotificationNodeContainer, ActionNodeContainer

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.

Method Summary

Modifier and Type	Method and Description
String	getDescription() Returns description text.
com.google.common.base.Optional<AugmentationSchema>	getOriginalDefinition() Returns Augmentation Definition from which this augmentation is derived if augmentation was added transitively via augmented uses.
String	getReference() Returns reference text.
Status	getStatus() Returns status of this node.
SchemaPath	getTargetPath() Returns augmentation schema path.
List<UnknownSchemaNode>	getUnknownSchemaNodes() Returns unknown schema node children.
RevisionAwareXPath	getWhenCondition() Returns when statement.

Methods inherited from interface org.opendaylight.yangtools.yang.model.api.DataNodeContainer

getChildNodes, getDataChildByName, getGroupings, getTypeDefinitions, getUses

Methods inherited from interface org.opendaylight.yangtools.yang.model.api.NotificationNodeContainer

getNotifications

Methods inherited from interface org.opendaylight.yangtools.yang.model.api.ActionNodeContainer

getActions

Method Detail

getWhenCondition

RevisionAwareXPath getWhenCondition()

Returns when statement.

If when condition is present node defined by the parent data definition statement is only valid when the returned XPath expression conceptually evaluates to "true" for a particular instance, then the node defined by the parent data definition statement is valid; otherwise, it is not.

Returns:

XPath condition

getDescription

String getDescription()

Returns description text.

Returns:

textual description of this augment.

getReference

String getReference()

Returns reference text.

Returns:

textual cross-reference to an external document that provides additional information relevant to this node.

getStatus

Status getStatus()

Returns status of this node.

Returns:

actual status of this node.

getTargetPath

SchemaPath getTargetPath()

Returns augmentation schema path.

Returns:

SchemaPath 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.

getUnknownSchemaNodes

List<UnknownSchemaNode> getUnknownSchemaNodes()

Returns unknown schema node children.

Returns:

collection of all unknown nodes defined in this augmentation

getOriginalDefinition

com.google.common.base.Optional<AugmentationSchema> getOriginalDefinition()

Returns Augmentation Definition from which this augmentation is derived if augmentation was added transitively via augmented uses.

Returns:

Augmentation Definition from which this augmentation is derived if augmentation was added transitively via augmented uses.