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

Interface DataNodeContainerBuilder

All Superinterfaces:

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

All Known Subinterfaces:

AugmentationSchemaBuilder, GroupingBuilder

All Known Implementing Classes:

AbstractDocumentedDataNodeContainerBuilder, AugmentationSchemaBuilderImpl, ChoiceCaseBuilder, ContainerSchemaNodeBuilder, GroupingBuilderImpl, ListSchemaNodeBuilder, ModuleBuilder, NotificationBuilder

public interface DataNodeContainerBuilder
extends Builder

Common builder for for all YANG DataNodeContainer augment, case, container, grouping, list, module, notification.

Method Summary

Methods

Modifier and Type	Method and Description
void	addChildNode(org.opendaylight.yangtools.yang.model.api.DataSchemaNode childNode)
void	addChildNode(DataSchemaNodeBuilder childNode) Add builder of child node to this node.
void	addChildNode(int index, DataSchemaNodeBuilder childNode) Add builder of child node to this node at specified position.
void	addChildNodeToContext(DataSchemaNodeBuilder childNode)
void	addGrouping(GroupingBuilder groupingBuilder) Add builder of grouping statement to this node.
void	addTypedef(TypeDefinitionBuilder typedefBuilder) Add typedef builder to this node.
void	addUsesNode(UsesNodeBuilder usesBuilder) Add builder of uses statement to this node.
org.opendaylight.yangtools.yang.model.api.DataNodeContainer	build() Returns an instance of product - DataNodeContainer Returns an instance of data node container with children and properties constructed as per this builder state, all nested builders are also built and their product is set to DataNodeContainer.
List<DataSchemaNodeBuilder>	getChildNodeBuilders() Returns list of of child node builders in order they are declared in yang file.
Map<org.opendaylight.yangtools.yang.common.QName,org.opendaylight.yangtools.yang.model.api.DataSchemaNode>	getChildNodes() Returns map of child nodes of this node.
DataSchemaNodeBuilder	getDataChildByName(String name) Retrieves child node builder by local name.
Set<GroupingBuilder>	getGroupingBuilders() Get builders of groupings defined in this node.
Set<org.opendaylight.yangtools.yang.model.api.GroupingDefinition>	getGroupings() Get already built groupings defined in this node.
org.opendaylight.yangtools.yang.model.api.SchemaPath	getPath() Returns Schema path of this node.
org.opendaylight.yangtools.yang.common.QName	getQName() Returns QName of this node.
Set<TypeDefinitionBuilder>	getTypeDefinitionBuilders() Returns builders of typedef statement defined in this node.
Set<org.opendaylight.yangtools.yang.model.api.TypeDefinition<?>>	getTypeDefinitions() Returns set of already built type definitions.
List<UsesNodeBuilder>	getUsesNodeBuilders() Get builders of uses defined in this node.

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

addUnknownNodeBuilder, getLine, getModuleName, getParent, getUnknownNodes, setModuleName, setParent

Method Detail

getQName

org.opendaylight.yangtools.yang.common.QName getQName()

Returns QName of this node.

Returns:

QName of this node

getPath

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

Returns Schema path of this node.

Returns:

SchemaPath of this node

getChildNodeBuilders

List<DataSchemaNodeBuilder> getChildNodeBuilders()

Returns list of of child node builders in order they are declared in yang file. This child node builder are build, during invoking build() and added as children to resulting DataNodeContainer.

Returns:

collection child nodes builders

getDataChildByName

DataSchemaNodeBuilder getDataChildByName(String name)

Retrieves child node builder by local name.

Parameters:

name - name of child to seek

Returns:

child node with given name if present, null otherwise

addChildNode

void addChildNode(DataSchemaNodeBuilder childNode)

Add builder of child node to this node.

Parameters:

childNode -

addChildNode

void addChildNode(int index,
                DataSchemaNodeBuilder childNode)

Add builder of child node to this node at specified position.

Parameters:

childNode -

addChildNode

void addChildNode(org.opendaylight.yangtools.yang.model.api.DataSchemaNode childNode)

addChildNodeToContext

void addChildNodeToContext(DataSchemaNodeBuilder childNode)

getGroupings

Set<org.opendaylight.yangtools.yang.model.api.GroupingDefinition> getGroupings()

Get already built groupings defined in this node.

Returns:

collection of GroupingDefinition objects

getGroupingBuilders

Set<GroupingBuilder> getGroupingBuilders()

Get builders of groupings defined in this node.

Returns:

collection of grouping builders

addGrouping

void addGrouping(GroupingBuilder groupingBuilder)

Add builder of grouping statement to this node.

Parameters:

groupingBuilder -

getUsesNodeBuilders

List<UsesNodeBuilder> getUsesNodeBuilders()

Get builders of uses defined in this node.

Returns:

collection of uses builders

addUsesNode

void addUsesNode(UsesNodeBuilder usesBuilder)

Add builder of uses statement to this node.

Parameters:

usesBuilder -

getTypeDefinitions

Set<org.opendaylight.yangtools.yang.model.api.TypeDefinition<?>> getTypeDefinitions()

Returns set of already built type definitions.

Returns:

set of already built type definitions.

getTypeDefinitionBuilders

Set<TypeDefinitionBuilder> getTypeDefinitionBuilders()

Returns builders of typedef statement defined in this node.

Returns:

builders of typedef statement defined in this node.

addTypedef

void addTypedef(TypeDefinitionBuilder typedefBuilder)

Add typedef builder to this node.

Parameters:

typedefBuilder - Builder to add to this node.

build

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

Returns an instance of product - DataNodeContainer Returns an instance of data node container with children and properties constructed as per this builder state, all nested builders are also built and their product is set to DataNodeContainer.

Specified by:

build in interface Builder

Returns:

Instance of DataNodeContainer

getChildNodes

Map<org.opendaylight.yangtools.yang.common.QName,org.opendaylight.yangtools.yang.model.api.DataSchemaNode> getChildNodes()

Returns map of child nodes of this node. Child nodes should be in same order as they were defined in yang file.

Returns:

map of child nodes of this node