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) Deprecated, for removal: This API element is subject to removal in a future version. -
Method Summary
Modifier and TypeMethodDescriptionDeprecated, for removal: This API element is subject to removal in a future version.ReturnEffectiveStatement
representation of this object.dataChildByName
(QName name) Deprecated, for removal: This API element is subject to removal in a future version.Returns the child node corresponding to the specified name.findAction
(QName qname) Deprecated, for removal: This API element is subject to removal in a future version.Find an action based on its QName.findNotification
(QName qname) Deprecated, for removal: This API element is subject to removal in a future version.Find a notification based on its QName.Collection<? extends ActionDefinition>
Deprecated, for removal: This API element is subject to removal in a future version.Return the set of actions.Collection<? extends DataSchemaNode>
Deprecated, for removal: This API element is subject to removal in a future version.Returns set of all child nodes defined within this DataNodeContainer.Deprecated, for removal: This API element is subject to removal in a future version.Returns the value of the argument of YANGdescription
keyword.Collection<? extends GroupingDefinition>
Deprecated, for removal: This API element is subject to removal in a future version.Returns set of all groupings defined within this DataNodeContainer.Collection<? extends NotificationDefinition>
Deprecated, for removal: This API element is subject to removal in a future version.Return the set of notifications in this container, keyed by QName.Deprecated, for removal: This API element is subject to removal in a future version.Returns the value of the argument of YANGreference
keyword.Deprecated, for removal: This API element is subject to removal in a future version.Returns status of the instance of the typeSchemaNode
.Collection<? extends TypeDefinition<?>>
Deprecated, for removal: This API element is subject to removal in a future version.Returns set of all newly defined types within this DataNodeContainer.Collection<? extends UnknownSchemaNode>
Deprecated, for removal: This API element is subject to removal in a future version.Returns unknown schema nodes which belongs to this instance.Collection<? extends UsesNode>
getUses()
Deprecated, for removal: This API element is subject to removal in a future version.Returns grouping nodes used ny this container.Optional<? extends YangXPathExpression.QualifiedBound>
Deprecated, for removal: This API element is subject to removal in a future version.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
Deprecated, for removal: This API element is subject to removal in a future version.
-
-
Method Details
-
getWhenCondition
Deprecated, for removal: This API element is subject to removal in a future version.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
Deprecated, for removal: This API element is subject to removal in a future version.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
Deprecated, for removal: This API element is subject to removal in a future version.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
Deprecated, for removal: This API element is subject to removal in a future version.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
Deprecated, for removal: This API element is subject to removal in a future version.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
Deprecated, for removal: This API element is subject to removal in a future version.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
Deprecated, for removal: This API element is subject to removal in a future version.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
Deprecated, for removal: This API element is subject to removal in a future version.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
Deprecated, for removal: This API element is subject to removal in a future version.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
Deprecated, for removal: This API element is subject to removal in a future version.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
Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:ActionNodeContainer
Return the set of actions.- Specified by:
getActions
in interfaceActionNodeContainer
- Returns:
- set of action nodes
-
findAction
Deprecated, for removal: This API element is subject to removal in a future version.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
Deprecated, for removal: This API element is subject to removal in a future version.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
Deprecated, for removal: This API element is subject to removal in a future version.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
Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:EffectiveStatementEquivalent
ReturnEffectiveStatement
representation of this object.- Specified by:
asEffectiveStatement
in interfaceEffectiveStatementEquivalent<AugmentEffectiveStatement>
- Returns:
EffectiveStatement
representation of this object.
-