org.opendaylight.yangtools.yang.parser.builder.util

Class AbstractDocumentedDataNodeContainerBuilder

java.lang.Object

org.opendaylight.yangtools.yang.parser.builder.util.AbstractBuilder

org.opendaylight.yangtools.yang.parser.builder.util.AbstractDocumentedNodeBuilder

org.opendaylight.yangtools.yang.parser.builder.util.AbstractDocumentedDataNodeContainerBuilder

All Implemented Interfaces:

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

Direct Known Subclasses:

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

public abstract class AbstractDocumentedDataNodeContainerBuilder
extends AbstractDocumentedNodeBuilder
implements DataNodeContainerBuilder

Basic implementation of DataNodeContainerBuilder.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.opendaylight.yangtools.yang.common.QName	qname

Fields inherited from class org.opendaylight.yangtools.yang.parser.builder.util.AbstractBuilder

addedUnknownNodes, unknownNodes

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDocumentedDataNodeContainerBuilder(String moduleName, int line, org.opendaylight.yangtools.yang.common.QName qname)
protected	AbstractDocumentedDataNodeContainerBuilder(String moduleName, int line, org.opendaylight.yangtools.yang.common.QName qname, org.opendaylight.yangtools.yang.model.api.SchemaPath path, org.opendaylight.yangtools.yang.model.api.DataNodeContainer base)

Method Summary

Methods

Modifier and Type	Method and Description
void	addChildNode(org.opendaylight.yangtools.yang.model.api.DataSchemaNode child)
void	addChildNode(DataSchemaNodeBuilder child) Add builder of child node to this node.
void	addChildNode(int index, DataSchemaNodeBuilder child) Add builder of child node to this node at specified position.
void	addChildNodeToContext(DataSchemaNodeBuilder child)
void	addGrouping(GroupingBuilder grouping) Add builder of grouping statement to this node.
void	addTypedef(TypeDefinitionBuilder type) Add typedef builder to this node.
void	addUsesNode(UsesNodeBuilder usesNode) Add builder of uses statement to this node.
protected void	buildChildren()
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.common.QName	getQName() Returns QName of this node.
protected abstract String	getStatementName()
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.
Set<org.opendaylight.yangtools.yang.model.api.UsesNode>	getUsesNodes()

Methods inherited from class org.opendaylight.yangtools.yang.parser.builder.util.AbstractDocumentedNodeBuilder

getDescription, getReference, getStatus, setDescription, setReference, setStatus

Methods inherited from class org.opendaylight.yangtools.yang.parser.builder.util.AbstractBuilder

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

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.parser.builder.api.DataNodeContainerBuilder

build, getPath

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

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

Field Detail

qname

protected final org.opendaylight.yangtools.yang.common.QName qname

Constructor Detail

AbstractDocumentedDataNodeContainerBuilder

protected AbstractDocumentedDataNodeContainerBuilder(String moduleName,
                                          int line,
                                          org.opendaylight.yangtools.yang.common.QName qname)

AbstractDocumentedDataNodeContainerBuilder

protected AbstractDocumentedDataNodeContainerBuilder(String moduleName,
                                          int line,
                                          org.opendaylight.yangtools.yang.common.QName qname,
                                          org.opendaylight.yangtools.yang.model.api.SchemaPath path,
                                          org.opendaylight.yangtools.yang.model.api.DataNodeContainer base)

Method Detail

getQName

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

Description copied from interface: DataNodeContainerBuilder

Returns QName of this node.

Specified by:

getQName in interface DataNodeContainerBuilder

Returns:

QName of this node

getChildNodes

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

Description copied from interface: DataNodeContainerBuilder

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

Specified by:

getChildNodes in interface DataNodeContainerBuilder

Returns:

map of child nodes of this node

getChildNodeBuilders

public final List<DataSchemaNodeBuilder> getChildNodeBuilders()

Description copied from interface: DataNodeContainerBuilder

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

Specified by:

getChildNodeBuilders in interface DataNodeContainerBuilder

Returns:

collection child nodes builders

getDataChildByName

public final DataSchemaNodeBuilder getDataChildByName(String name)

Description copied from interface: DataNodeContainerBuilder

Retrieves child node builder by local name.

Specified by:

getDataChildByName in interface DataNodeContainerBuilder

Parameters:

name - name of child to seek

Returns:

child node with given name if present, null otherwise

addChildNode

public final void addChildNode(DataSchemaNodeBuilder child)

Description copied from interface: DataNodeContainerBuilder

Add builder of child node to this node.

Specified by:

addChildNode in interface DataNodeContainerBuilder

addChildNode

public final void addChildNode(int index,
                DataSchemaNodeBuilder child)

Description copied from interface: DataNodeContainerBuilder

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

Specified by:

addChildNode in interface DataNodeContainerBuilder

addChildNodeToContext

public final void addChildNodeToContext(DataSchemaNodeBuilder child)

Specified by:

addChildNodeToContext in interface DataNodeContainerBuilder

addChildNode

public final void addChildNode(org.opendaylight.yangtools.yang.model.api.DataSchemaNode child)

Specified by:

addChildNode in interface DataNodeContainerBuilder

getGroupings

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

Description copied from interface: DataNodeContainerBuilder

Get already built groupings defined in this node.

Specified by:

getGroupings in interface DataNodeContainerBuilder

Returns:

collection of GroupingDefinition objects

getGroupingBuilders

public final Set<GroupingBuilder> getGroupingBuilders()

Description copied from interface: DataNodeContainerBuilder

Get builders of groupings defined in this node.

Specified by:

getGroupingBuilders in interface DataNodeContainerBuilder

Returns:

collection of grouping builders

addGrouping

public final void addGrouping(GroupingBuilder grouping)

Description copied from interface: DataNodeContainerBuilder

Add builder of grouping statement to this node.

Specified by:

addGrouping in interface DataNodeContainerBuilder

getTypeDefinitions

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

Description copied from interface: DataNodeContainerBuilder

Returns set of already built type definitions.

Specified by:

getTypeDefinitions in interface DataNodeContainerBuilder

Returns:

set of already built type definitions.

getUsesNodes

public final Set<org.opendaylight.yangtools.yang.model.api.UsesNode> getUsesNodes()

getUsesNodeBuilders

public final List<UsesNodeBuilder> getUsesNodeBuilders()

Description copied from interface: DataNodeContainerBuilder

Get builders of uses defined in this node.

Specified by:

getUsesNodeBuilders in interface DataNodeContainerBuilder

Returns:

collection of uses builders

addUsesNode

public final void addUsesNode(UsesNodeBuilder usesNode)

Description copied from interface: DataNodeContainerBuilder

Add builder of uses statement to this node.

Specified by:

addUsesNode in interface DataNodeContainerBuilder

getTypeDefinitionBuilders

public final Set<TypeDefinitionBuilder> getTypeDefinitionBuilders()

Description copied from interface: DataNodeContainerBuilder

Returns builders of typedef statement defined in this node.

Specified by:

getTypeDefinitionBuilders in interface DataNodeContainerBuilder

Returns:

builders of typedef statement defined in this node.

addTypedef

public void addTypedef(TypeDefinitionBuilder type)

Description copied from interface: DataNodeContainerBuilder

Add typedef builder to this node.

Specified by:

addTypedef in interface DataNodeContainerBuilder

Parameters:

type - Builder to add to this node.

getStatementName

protected abstract String getStatementName()

buildChildren

protected void buildChildren()