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

Interface Builder

All Superinterfaces:

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

All Known Subinterfaces:

AugmentationSchemaBuilder, DataNodeContainerBuilder, DataSchemaNodeBuilder, ExtensionBuilder, GroupingBuilder, GroupingMember, SchemaNodeBuilder, TypeAwareBuilder, TypeDefinitionBuilder, UnknownSchemaNodeBuilder, UsesNodeBuilder

All Known Implementing Classes:

AbstractBuilder, AbstractDocumentedDataNodeContainerBuilder, AbstractDocumentedNodeBuilder, AbstractSchemaNodeBuilder, AbstractTypeAwareBuilder, AnyXmlBuilder, AugmentationSchemaBuilderImpl, ChoiceBuilder, ChoiceCaseBuilder, ContainerSchemaNodeBuilder, DeviationBuilder, ExtensionBuilderImpl, FeatureBuilder, GroupingBuilderImpl, IdentityrefTypeBuilder, IdentitySchemaNodeBuilder, LeafListSchemaNodeBuilder, LeafSchemaNodeBuilder, ListSchemaNodeBuilder, ModuleBuilder, NotificationBuilder, RefineHolderImpl, RpcDefinitionBuilder, TypeDefinitionBuilderImpl, UnionTypeBuilder, UnknownSchemaNodeBuilderImpl, UsesNodeBuilderImpl

public interface Builder
extends org.opendaylight.yangtools.concepts.Mutable

Parent interface for all builder interfaces.

Method Summary

Methods

Modifier and Type	Method and Description
void	addUnknownNodeBuilder(UnknownSchemaNodeBuilder unknownNode) Adds an unknown node builder to this builder.
Object	build() Build YANG data model node.
int	getLine() Get current line in yang file, on which statement associated with this builder was declared.
String	getModuleName() Returns name of module in which node created by this builder was declared.
Builder	getParent() Returns parent node builder of this node.
List<UnknownSchemaNodeBuilder>	getUnknownNodes() Get builders of unknown nodes defined in this node.
void	setModuleName(String moduleName) Deprecated. Module name should be set during creation of builder.
void	setParent(Builder parent) Set parent of this node.

Method Detail

getModuleName

String getModuleName()

Returns name of module in which node created by this builder was declared.

Returns:

module name

setModuleName

@Deprecated
void setModuleName(String moduleName)

Deprecated. Module name should be set during creation of builder.

Set name of module in which this node is declared.

Parameters:

moduleName -

getLine

int getLine()

Get current line in yang file, on which statement associated with this builder was declared.

Returns:

current line in yang file

getParent

Builder getParent()

Returns parent node builder of this node.

Returns:

parent node builder or null if this is top level node

setParent

void setParent(Builder parent)

Set parent of this node.

Parameters:

parent - parent node builder

addUnknownNodeBuilder

void addUnknownNodeBuilder(UnknownSchemaNodeBuilder unknownNode)

Adds an unknown node builder to this builder. When product (child) is builded by the build() method, this builder is also built and unknown node is added as child to the product of this builder.

Parameters:

unknownNode -

getUnknownNodes

List<UnknownSchemaNodeBuilder> getUnknownNodes()

Get builders of unknown nodes defined in this node.

Returns:

collection of UnknownSchemaNodeBuilder objects

build

Object build()

Build YANG data model node. This method should create an instance of YANG data model node. After creating an instance, this instance should be returned for each call without repeating build process.

Returns:

YANG data model node