Class EffectiveAugmentationSchema
- All Implemented Interfaces:
ActionNodeContainer
,AugmentationSchemaNode
,DataNodeContainer
,DocumentedNode
,DocumentedNode.WithStatus
,EffectiveStatementEquivalent<AugmentEffectiveStatement>
,NotificationNodeContainer
,WhenConditionAware
container foo;
augment /foo {
container bar;
}
augment /foo/bar {
container baz;
}
The AugmentationSchemaNode
returned for augment /foo
contains bare container bar
, e.g. it
does not show augment /foo/bar
as an available augmentation -- this is only visible in foo
's schema
nodes.
Note this class only handles DataSchemaNode
s, not all schema tree
statements, as it strictly should.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.opendaylight.yangtools.yang.model.api.DocumentedNode
DocumentedNode.WithStatus
-
Constructor Summary
ConstructorsConstructorDescriptionEffectiveAugmentationSchema
(AugmentationSchemaNode augment, DataNodeContainer target) -
Method Summary
Modifier and TypeMethodDescriptionReturnEffectiveStatement
representation of this object.dataChildByName
(QName name) Returns the child node corresponding to the specified name.findAction
(QName qname) Find an action based on its QName.findNotification
(QName qname) Find a notification based on its QName.Collection<? extends ActionDefinition>
Return the set of actions.Collection<? extends DataSchemaNode>
Returns set of all child nodes defined within this DataNodeContainer.Returns the value of the argument of YANGdescription
keyword.Collection<? extends GroupingDefinition>
Returns set of all groupings defined within this DataNodeContainer.Collection<? extends NotificationDefinition>
Return the set of notifications in this container, keyed by QName.Returns the value of the argument of YANGreference
keyword.Returns status of the instance of the typeSchemaNode
.Collection<? extends TypeDefinition<?>>
Returns set of all newly defined types within this DataNodeContainer.Collection<? extends UnknownSchemaNode>
Returns unknown schema nodes which belongs to this instance.Collection<? extends UsesNode>
getUses()
Returns grouping nodes used ny this container.Optional<? extends YangXPathExpression.QualifiedBound>
Returns when statement.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode
getTargetPath
Methods inherited from interface org.opendaylight.yangtools.yang.model.api.DataNodeContainer
findDataChildByName, findDataChildByName, findDataTreeChild, findDataTreeChild, findDataTreeChild, getDataChildByName
-
Constructor Details
-
EffectiveAugmentationSchema
-
-
Method Details
-
getWhenCondition
Description copied from interface:WhenConditionAware
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.
- Specified by:
getWhenCondition
in interfaceWhenConditionAware
- Returns:
- XPath condition
-
getDescription
Description copied from interface:DocumentedNode
Returns the value of the argument of YANGdescription
keyword.- Specified by:
getDescription
in interfaceDocumentedNode
- Returns:
- string with the description, or empty if description was not provided.
-
getReference
Description copied from interface:DocumentedNode
Returns the value of the argument of YANGreference
keyword.- Specified by:
getReference
in interfaceDocumentedNode
- Returns:
- string with reference to some other document, or empty if reference was not provided.
-
getStatus
Description copied from interface:DocumentedNode.WithStatus
Returns status of the instance of the typeSchemaNode
.- Specified by:
getStatus
in interfaceDocumentedNode.WithStatus
- Returns:
- status of this node which represents the argument of the YANG
status
substatement
-
getUnknownSchemaNodes
Description copied from interface:DocumentedNode
Returns unknown schema nodes which belongs to this instance. Default implementation returns an empty collection.- Specified by:
getUnknownSchemaNodes
in interfaceDocumentedNode
- Returns:
- collection of unknown schema nodes defined under this node.
-
getTypeDefinitions
Description copied from interface:DataNodeContainer
Returns set of all newly defined types within this DataNodeContainer.- Specified by:
getTypeDefinitions
in interfaceDataNodeContainer
- Returns:
- typedef statements in lexicographical order
-
getChildNodes
Description copied from interface:DataNodeContainer
Returns set of all child nodes defined within this DataNodeContainer. Although the return type is a collection, each node is guaranteed to be present at most once.Note that the nodes returned are NOT
data nodes
, but ratherDataSchemaNode
s, henceChoiceSchemaNode
andCaseSchemaNode
are present instead of their children. This is consistent withschema tree
.- Specified by:
getChildNodes
in interfaceDataNodeContainer
- Returns:
- child nodes in lexicographical order
-
getGroupings
Description copied from interface:DataNodeContainer
Returns set of all groupings defined within this DataNodeContainer.- Specified by:
getGroupings
in interfaceDataNodeContainer
- Returns:
- grouping statements in lexicographical order
-
dataChildByName
Description copied from interface:DataNodeContainer
Returns the child node corresponding to the specified name.Note that the nodes searched are NOT
data nodes
, but ratherDataSchemaNode
s, henceChoiceSchemaNode
andCaseSchemaNode
are returned instead of their matching children. This is consistent withschema tree
.- Specified by:
dataChildByName
in interfaceDataNodeContainer
- Parameters:
name
- QName of child- Returns:
- child node of this DataNodeContainer if child with given name is present, null otherwise
-
getUses
Description copied from interface:DataNodeContainer
Returns grouping nodes used ny this container.- Specified by:
getUses
in interfaceDataNodeContainer
- Returns:
- Set of all uses nodes defined within this DataNodeContainer
-
getActions
Description copied from interface:ActionNodeContainer
Return the set of actions.- Specified by:
getActions
in interfaceActionNodeContainer
- Returns:
- set of action nodes
-
findAction
Description copied from interface:ActionNodeContainer
Find an action based on its QName. Default implementation searches the set returned byActionNodeContainer.getActions()
.- Specified by:
findAction
in interfaceActionNodeContainer
- Parameters:
qname
- Action's QName- Returns:
- Action definition, if found
-
getNotifications
Description copied from interface:NotificationNodeContainer
Return the set of notifications in this container, keyed by QName. RFC7950 specifies thatAugmentationSchemaNode
s,GroupingDefinition
s,ListSchemaNode
s andContainerSchemaNode
s can also containNotificationDefinition
s.- Specified by:
getNotifications
in interfaceNotificationNodeContainer
- Returns:
- set of notification nodes
-
findNotification
Description copied from interface:NotificationNodeContainer
Find a notification based on its QName. Default implementation searches the set returned byNotificationNodeContainer.getNotifications()
.- Specified by:
findNotification
in interfaceNotificationNodeContainer
- Parameters:
qname
- Notification QName- Returns:
- Notification definition, if found
-
asEffectiveStatement
Description copied from interface:EffectiveStatementEquivalent
ReturnEffectiveStatement
representation of this object.- Specified by:
asEffectiveStatement
in interfaceEffectiveStatementEquivalent<AugmentEffectiveStatement>
- Returns:
EffectiveStatement
representation of this object.
-