org.opendaylight.yangtools.yang.model.api

Interface UsesNode

All Superinterfaces:

DocumentedNode, DocumentedNode.WithStatus

All Known Implementing Classes:

UsesEffectiveStatementImpl

public interface UsesNode
extends DocumentedNode.WithStatus

Contains the methods for getting data and checking properties of the YANG uses substatement.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opendaylight.yangtools.yang.model.api.DocumentedNode

DocumentedNode.WithStatus

Method Summary

Modifier and Type	Method and Description
Set<AugmentationSchema>	getAugmentations() Returns augmentations which were specified in this uses node.
SchemaPath	getGroupingPath() Returns the schema path to used grouping.
Map<SchemaPath,SchemaNode>	getRefines() Some of the properties of each node in the grouping can be refined with the "refine" statement.
default com.google.common.base.Optional<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.
boolean	isAddedByUses() Returns true if the data node was added by uses statement, otherwise returns false
boolean	isAugmenting() Returns true if the data node was added by augmentation, otherwise returns false

Methods inherited from interface org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus

getStatus

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

getDescription, getReference, getUnknownSchemaNodes

Method Detail

getGroupingPath

@Nonnull
SchemaPath getGroupingPath()

Returns the schema path to used grouping.

Returns:

schema path to 'grouping' on which this 'uses' statement points

getAugmentations

@Nonnull
Set<AugmentationSchema> getAugmentations()

Returns augmentations which were specified in this uses node.

Returns:

Set of augment statements defined under this uses node

isAugmenting

boolean isAugmenting()

Returns true if the data node was added by augmentation, otherwise returns false

Returns:

true if the data node was added by augmentation, otherwise returns false

isAddedByUses

boolean isAddedByUses()

Returns true if the data node was added by uses statement, otherwise returns false

Returns:

true if the data node was added by uses statement, otherwise returns false

getRefines

@Nonnull
Map<SchemaPath,SchemaNode> getRefines()

Some of the properties of each node in the grouping can be refined with the "refine" statement.

Returns:

Map, where key is schema path of refined node and value is refined node

getWhenCondition

@Nonnull
default com.google.common.base.Optional<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:

Optional of XPath condition