org.opendaylight.yangtools.yang.parser.builder.api

Interface UsesNodeBuilder

All Superinterfaces:

Builder, GroupingMember, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>

All Known Implementing Classes:

UsesNodeBuilderImpl

public interface UsesNodeBuilder
extends GroupingMember

Builder for 'uses' statement.

Method Summary

Methods

Modifier and Type	Method and Description
void	addAugment(AugmentationSchemaBuilder builder) Add augment builder.
void	addRefine(RefineBuilder refine) Add refine statement.
void	addRefineNode(DataSchemaNodeBuilder refineNode) Add refine node.
org.opendaylight.yangtools.yang.model.api.UsesNode	build() Build new UsesNode object.
Set<AugmentationSchemaBuilder>	getAugmentations() Get augmentations defined in this uses node.
GroupingBuilder	getGroupingBuilder() Get grouping builder.
org.opendaylight.yangtools.yang.model.api.GroupingDefinition	getGroupingDefinition() Get grouping definition.
org.opendaylight.yangtools.yang.model.api.SchemaPath	getGroupingPath() Get grouping path.
DataNodeContainerBuilder	getParent() Get parent of this uses node.
List<SchemaNodeBuilder>	getRefineNodes() Get refined nodes.
List<RefineBuilder>	getRefines() Get refine statements.
org.opendaylight.yangtools.yang.model.api.SchemaPath	getTargetGroupingPath() Get target grouping path.
boolean	isAugmenting() Get information if this uses node is defined in augment.
boolean	isResolved() Returns true if uses node was resolved and getGroupingBuilder() was instantiated for parent done of this node.
void	setAugmenting(boolean augmenting) Set information if this uses node is defined in augment.
void	setGrouping(GroupingBuilder grouping) Set grouping builder.
void	setGroupingDefinition(org.opendaylight.yangtools.yang.model.api.GroupingDefinition groupingDefinition) Set grouping definition.
void	setResolved(boolean resolved) Deprecated. Do not use this, this should be internal to the implementation and public API contract.

Methods inherited from interface org.opendaylight.yangtools.yang.parser.builder.api.GroupingMember

isAddedByUses, setAddedByUses

Methods inherited from interface org.opendaylight.yangtools.yang.parser.builder.api.Builder

addUnknownNodeBuilder, getLine, getModuleName, getUnknownNodes, setModuleName, setParent

Method Detail

getParent

DataNodeContainerBuilder getParent()

Get parent of this uses node. Since uses can be defined only under on of module, container, list, case, grouping, input, output, notification or augment, return type is DataNodeContainerBuilder.

Specified by:

getParent in interface Builder

Returns:

parent node builder or null if this is top level node

getTargetGroupingPath

org.opendaylight.yangtools.yang.model.api.SchemaPath getTargetGroupingPath()

Get target grouping path.

Returns:

target grouping path

getGroupingPath

org.opendaylight.yangtools.yang.model.api.SchemaPath getGroupingPath()

Get grouping path.

Returns:

grouping path as SchemaPath

getGroupingDefinition

org.opendaylight.yangtools.yang.model.api.GroupingDefinition getGroupingDefinition()

Get grouping definition.

Returns:

GroupingDefinition if present, null otherwise

setGroupingDefinition

void setGroupingDefinition(org.opendaylight.yangtools.yang.model.api.GroupingDefinition groupingDefinition)

Set grouping definition.

Parameters:

groupingDefinition - GroupingDefinition object

getGroupingBuilder

GroupingBuilder getGroupingBuilder()

Get grouping builder.

Returns:

GroupingBuilder if present, null otherwise

setGrouping

void setGrouping(GroupingBuilder grouping)

Set grouping builder.

Parameters:

grouping - GroupingBuilder object

isAugmenting

boolean isAugmenting()

Get information if this uses node is defined in augment.

Returns:

true, if this node is defined under augment statement, false otherwise

setAugmenting

void setAugmenting(boolean augmenting)

Set information if this uses node is defined in augment.

Parameters:

augmenting -

getAugmentations

Set<AugmentationSchemaBuilder> getAugmentations()

Get augmentations defined in this uses node.

Returns:

set of augmentations defined in this node

addAugment

void addAugment(AugmentationSchemaBuilder builder)

Add augment builder.

Parameters:

builder - new builder of augment statement

getRefines

List<RefineBuilder> getRefines()

Get refine statements.

Returns:

list of RefineHolder objects

getRefineNodes

List<SchemaNodeBuilder> getRefineNodes()

Get refined nodes.

Returns:

List of refined SchemaNodeBuilder objects

addRefine

void addRefine(RefineBuilder refine)

Add refine statement.

Parameters:

refine - new RefineHolder object

addRefineNode

void addRefineNode(DataSchemaNodeBuilder refineNode)

Add refine node.

Parameters:

refineNode - refined DataSchemaNodeBuilder object

build

org.opendaylight.yangtools.yang.model.api.UsesNode build()

Build new UsesNode object.

Specified by:

build in interface Builder

Returns:

UsesNode Instance of UsesNode described by this builder.

isResolved

boolean isResolved()

Returns true if uses node was resolved and getGroupingBuilder() was instantiated for parent done of this node.

Returns:

true if uses node was resolved and associated nodes were instantiated in parent node.

setResolved

@Deprecated
void setResolved(boolean resolved)

Deprecated. Do not use this, this should be internal to the implementation and public API contract.

Sets state of instantiation of getGroupingBuilder() into parent node of this node.