org.opendaylight.yangtools.yang.parser.builder.impl

Class ModuleBuilder

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

org.opendaylight.yangtools.yang.parser.builder.impl.ModuleBuilder

All Implemented Interfaces:

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

public class ModuleBuilder
extends AbstractDocumentedDataNodeContainerBuilder
implements DocumentedNodeBuilder

Builder of Module object. If this module is dependent on external module/modules, these dependencies must be resolved before module is built, otherwise result may not be valid.

Field Summary

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

qname

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

addedUnknownNodes, unknownNodes

Constructor Summary

Constructors

Constructor and Description
ModuleBuilder(org.opendaylight.yangtools.yang.model.api.Module base)
ModuleBuilder(String name, boolean submodule, String sourcePath)
ModuleBuilder(String name, String sourcePath)

Method Summary

Methods

Modifier and Type	Method and Description
AnyXmlBuilder	addAnyXml(int line, org.opendaylight.yangtools.yang.common.QName qname, org.opendaylight.yangtools.yang.model.api.SchemaPath schemaPath)
AugmentationSchemaBuilder	addAugment(int line, String augmentTargetStr, org.opendaylight.yangtools.yang.model.api.SchemaPath targetPath, int order)
ChoiceCaseBuilder	addCase(int line, org.opendaylight.yangtools.yang.common.QName qname, org.opendaylight.yangtools.yang.model.api.SchemaPath path)
ChoiceBuilder	addChoice(int line, org.opendaylight.yangtools.yang.common.QName qname, org.opendaylight.yangtools.yang.model.api.SchemaPath path)
ContainerSchemaNodeBuilder	addContainerNode(int line, org.opendaylight.yangtools.yang.common.QName qname, org.opendaylight.yangtools.yang.model.api.SchemaPath schemaPath)
DeviationBuilder	addDeviation(int line, org.opendaylight.yangtools.yang.model.api.SchemaPath targetPath)
ExtensionBuilder	addExtension(org.opendaylight.yangtools.yang.common.QName qname, int line, org.opendaylight.yangtools.yang.model.api.SchemaPath path)
FeatureBuilder	addFeature(int line, org.opendaylight.yangtools.yang.common.QName qname, org.opendaylight.yangtools.yang.model.api.SchemaPath path)
GroupingBuilder	addGrouping(int line, org.opendaylight.yangtools.yang.common.QName qname, org.opendaylight.yangtools.yang.model.api.SchemaPath path)
IdentitySchemaNodeBuilder	addIdentity(org.opendaylight.yangtools.yang.common.QName qname, int line, org.opendaylight.yangtools.yang.model.api.SchemaPath path)
void	addIdentityrefType(int line, org.opendaylight.yangtools.yang.model.api.SchemaPath schemaPath, String baseString)
void	addImportedModule(String prefix, ModuleBuilder module)
void	addInclude(String name, Date revision)
LeafListSchemaNodeBuilder	addLeafListNode(int line, org.opendaylight.yangtools.yang.common.QName qname, org.opendaylight.yangtools.yang.model.api.SchemaPath schemaPath)
LeafSchemaNodeBuilder	addLeafNode(int line, org.opendaylight.yangtools.yang.common.QName qname, org.opendaylight.yangtools.yang.model.api.SchemaPath schemaPath)
ListSchemaNodeBuilder	addListNode(int line, org.opendaylight.yangtools.yang.common.QName qname, org.opendaylight.yangtools.yang.model.api.SchemaPath schemaPath)
void	addModuleImport(String moduleName, Date revision, String prefix)
NotificationBuilder	addNotification(int line, org.opendaylight.yangtools.yang.common.QName qname, org.opendaylight.yangtools.yang.model.api.SchemaPath path)
void	addNotification(org.opendaylight.yangtools.yang.model.api.NotificationDefinition notification)
void	addRefine(RefineHolderImpl refine)
RpcDefinitionBuilder	addRpc(int line, org.opendaylight.yangtools.yang.common.QName qname, org.opendaylight.yangtools.yang.model.api.SchemaPath path)
ContainerSchemaNodeBuilder	addRpcInput(int line, org.opendaylight.yangtools.yang.common.QName qname, org.opendaylight.yangtools.yang.model.api.SchemaPath schemaPath)
ContainerSchemaNodeBuilder	addRpcOutput(org.opendaylight.yangtools.yang.model.api.SchemaPath schemaPath, org.opendaylight.yangtools.yang.common.QName qname, int line)
void	addSubmodule(ModuleBuilder submodule)
TypeDefinitionBuilderImpl	addTypedef(int line, org.opendaylight.yangtools.yang.common.QName qname, org.opendaylight.yangtools.yang.model.api.SchemaPath path)
void	addTypedef(TypeDefinitionBuilder typedefBuilder) Add typedef builder to this node.
UnionTypeBuilder	addUnionType(int line, org.opendaylight.yangtools.yang.common.QNameModule module)
void	addUnknownNodeBuilder(UnknownSchemaNodeBuilder builder) Adds an unknown node builder to this builder.
UnknownSchemaNodeBuilderImpl	addUnknownSchemaNode(int line, org.opendaylight.yangtools.yang.common.QName qname, org.opendaylight.yangtools.yang.model.api.SchemaPath path)
UsesNodeBuilder	addUsesNode(int line, org.opendaylight.yangtools.yang.model.api.SchemaPath grouping)
org.opendaylight.yangtools.yang.model.api.Module	build() Build new Module object based on this builder.
void	enterNode(Builder node)
boolean	equals(Object obj)
void	exitNode()
Builder	getActualNode()
List<ExtensionBuilder>	getAddedExtensions()
Set<FeatureBuilder>	getAddedFeatures()
Set<IdentitySchemaNodeBuilder>	getAddedIdentities()
Set<NotificationBuilder>	getAddedNotifications()
Set<RpcDefinitionBuilder>	getAddedRpcs()
List<AugmentationSchemaBuilder>	getAllAugments()
List<GroupingBuilder>	getAllGroupings()
List<ListSchemaNodeBuilder>	getAllLists()
List<UnknownSchemaNodeBuilder>	getAllUnknownNodes()
List<UsesNodeBuilder>	getAllUsesNodes()
List<AugmentationSchemaBuilder>	getAugmentBuilders()
Set<org.opendaylight.yangtools.yang.model.api.AugmentationSchema>	getAugments()
String	getBelongsTo()
String	getContact()
Set<DeviationBuilder>	getDeviationBuilders()
Set<org.opendaylight.yangtools.yang.model.api.Deviation>	getDeviations()
Set<TypeAwareBuilder>	getDirtyNodes()
List<org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode>	getExtensionInstances()
List<org.opendaylight.yangtools.yang.model.api.ExtensionDefinition>	getExtensions()
Set<org.opendaylight.yangtools.yang.model.api.FeatureDefinition>	getFeatures()
Set<org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode>	getIdentities()
org.opendaylight.yangtools.yang.model.api.ModuleImport	getImport(String prefix)
ModuleBuilder	getImportedModule(String prefix)
Map<String,org.opendaylight.yangtools.yang.model.api.ModuleImport>	getImports()
Map<String,Date>	getIncludedModules()
String	getModuleSourcePath()
String	getName()
URI	getNamespace()
Set<org.opendaylight.yangtools.yang.model.api.NotificationDefinition>	getNotifications()
String	getOrganization()
ModuleBuilder	getParent() Returns parent node builder of this node.
org.opendaylight.yangtools.yang.model.api.SchemaPath	getPath() Returns Schema path of this node.
String	getPrefix()
org.opendaylight.yangtools.yang.common.QNameModule	getQNameModule()
Date	getRevision()
Set<org.opendaylight.yangtools.yang.model.api.RpcDefinition>	getRpcs()
protected String	getSource()
protected String	getStatementName()
String	getYangVersion()
int	hashCode()
boolean	isSubmodule()
void	markActualNodeDirty()
void	setBelongsTo(String belongsTo)
void	setContact(String contact)
void	setNamespace(URI namespace)
void	setOrganization(String organization)
void	setParent(Builder parent) Set parent of this node.
void	setParent(ModuleBuilder parent)
void	setPrefix(String prefix)
void	setQNameModule(org.opendaylight.yangtools.yang.common.QNameModule qnameModule)
void	setRevision(Date revision)
void	setSource(com.google.common.io.ByteSource byteSource)
void	setSource(String source)
void	setType(org.opendaylight.yangtools.yang.model.api.TypeDefinition<?> type)
void	setYangVersion(String yangVersion)
String	toString()

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

addChildNode, addChildNode, addChildNode, addChildNodeToContext, addGrouping, addUsesNode, buildChildren, getChildNodeBuilders, getChildNodes, getDataChildByName, getGroupingBuilders, getGroupings, getQName, getTypeDefinitionBuilders, getTypeDefinitions, getUsesNodeBuilders, 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

checkNotSealed, getLine, getModuleName, getUnknownNodes, setModuleName

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getDescription, getReference, getStatus, setDescription, setReference, setStatus

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

getLine, getModuleName, getUnknownNodes, setModuleName

Constructor Detail

ModuleBuilder

public ModuleBuilder(String name,
             String sourcePath)

ModuleBuilder

public ModuleBuilder(String name,
             boolean submodule,
             String sourcePath)

ModuleBuilder

public ModuleBuilder(org.opendaylight.yangtools.yang.model.api.Module base)

Method Detail

getStatementName

protected String getStatementName()

Specified by:

getStatementName in class AbstractDocumentedDataNodeContainerBuilder

build

public org.opendaylight.yangtools.yang.model.api.Module build()

Build new Module object based on this builder.

Specified by:

build in interface Builder

Specified by:

build in interface DataNodeContainerBuilder

Returns:

Instance of DataNodeContainer

getModuleSourcePath

public String getModuleSourcePath()

getParent

public ModuleBuilder getParent()

Description copied from interface: Builder

Returns parent node builder of this node.

Specified by:

getParent in interface Builder

Overrides:

getParent in class AbstractBuilder

Returns:

parent node builder or null if this is top level node

setParent

public void setParent(ModuleBuilder parent)

setParent

public void setParent(Builder parent)

Description copied from interface: Builder

Set parent of this node.

Specified by:

setParent in interface Builder

Overrides:

setParent in class AbstractBuilder

Parameters:

parent - parent node builder

getPath

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

Description copied from interface: DataNodeContainerBuilder

Returns Schema path of this node.

Specified by:

getPath in interface DataNodeContainerBuilder

Returns:

SchemaPath of this node

enterNode

public void enterNode(Builder node)

exitNode

public void exitNode()

getActualNode

public Builder getActualNode()

getDirtyNodes

public Set<TypeAwareBuilder> getDirtyNodes()

getAugments

public Set<org.opendaylight.yangtools.yang.model.api.AugmentationSchema> getAugments()

getAugmentBuilders

public List<AugmentationSchemaBuilder> getAugmentBuilders()

getAllAugments

public List<AugmentationSchemaBuilder> getAllAugments()

getIdentities

public Set<org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode> getIdentities()

getAddedIdentities

public Set<IdentitySchemaNodeBuilder> getAddedIdentities()

getFeatures

public Set<org.opendaylight.yangtools.yang.model.api.FeatureDefinition> getFeatures()

getAddedFeatures

public Set<FeatureBuilder> getAddedFeatures()

getAllGroupings

public List<GroupingBuilder> getAllGroupings()

getAllUsesNodes

public List<UsesNodeBuilder> getAllUsesNodes()

getDeviations

public Set<org.opendaylight.yangtools.yang.model.api.Deviation> getDeviations()

getDeviationBuilders

public Set<DeviationBuilder> getDeviationBuilders()

getExtensions

public List<org.opendaylight.yangtools.yang.model.api.ExtensionDefinition> getExtensions()

getAddedExtensions

public List<ExtensionBuilder> getAddedExtensions()

getAllUnknownNodes

public List<UnknownSchemaNodeBuilder> getAllUnknownNodes()

getAllLists

public List<ListSchemaNodeBuilder> getAllLists()

getName

public String getName()

getNamespace

public URI getNamespace()

getQNameModule

public org.opendaylight.yangtools.yang.common.QNameModule getQNameModule()

setQNameModule

public void setQNameModule(org.opendaylight.yangtools.yang.common.QNameModule qnameModule)

setNamespace

public void setNamespace(URI namespace)

getPrefix

public String getPrefix()

getRevision

public Date getRevision()

getImport

public org.opendaylight.yangtools.yang.model.api.ModuleImport getImport(String prefix)

getImports

public Map<String,org.opendaylight.yangtools.yang.model.api.ModuleImport> getImports()

getImportedModule

public ModuleBuilder getImportedModule(String prefix)

addImportedModule

public void addImportedModule(String prefix,
                     ModuleBuilder module)

getIncludedModules

public Map<String,Date> getIncludedModules()

addInclude

public void addInclude(String name,
              Date revision)

addSubmodule

public void addSubmodule(ModuleBuilder submodule)

getSource

protected String getSource()

isSubmodule

public boolean isSubmodule()

getBelongsTo

public String getBelongsTo()

setBelongsTo

public void setBelongsTo(String belongsTo)

markActualNodeDirty

public void markActualNodeDirty()

setRevision

public void setRevision(Date revision)

setPrefix

public void setPrefix(String prefix)

setYangVersion

public void setYangVersion(String yangVersion)

setOrganization

public void setOrganization(String organization)

setContact

public void setContact(String contact)

addModuleImport

public void addModuleImport(String moduleName,
                   Date revision,
                   String prefix)

addExtension

public ExtensionBuilder addExtension(org.opendaylight.yangtools.yang.common.QName qname,
                            int line,
                            org.opendaylight.yangtools.yang.model.api.SchemaPath path)

addContainerNode

public ContainerSchemaNodeBuilder addContainerNode(int line,
                                          org.opendaylight.yangtools.yang.common.QName qname,
                                          org.opendaylight.yangtools.yang.model.api.SchemaPath schemaPath)

addListNode

public ListSchemaNodeBuilder addListNode(int line,
                                org.opendaylight.yangtools.yang.common.QName qname,
                                org.opendaylight.yangtools.yang.model.api.SchemaPath schemaPath)

addLeafNode

public LeafSchemaNodeBuilder addLeafNode(int line,
                                org.opendaylight.yangtools.yang.common.QName qname,
                                org.opendaylight.yangtools.yang.model.api.SchemaPath schemaPath)

addLeafListNode

public LeafListSchemaNodeBuilder addLeafListNode(int line,
                                        org.opendaylight.yangtools.yang.common.QName qname,
                                        org.opendaylight.yangtools.yang.model.api.SchemaPath schemaPath)

addGrouping

public GroupingBuilder addGrouping(int line,
                          org.opendaylight.yangtools.yang.common.QName qname,
                          org.opendaylight.yangtools.yang.model.api.SchemaPath path)

addAugment

public AugmentationSchemaBuilder addAugment(int line,
                                   String augmentTargetStr,
                                   org.opendaylight.yangtools.yang.model.api.SchemaPath targetPath,
                                   int order)

addUsesNode

public UsesNodeBuilder addUsesNode(int line,
                          org.opendaylight.yangtools.yang.model.api.SchemaPath grouping)

addRefine

public void addRefine(RefineHolderImpl refine)

addRpc

public RpcDefinitionBuilder addRpc(int line,
                          org.opendaylight.yangtools.yang.common.QName qname,
                          org.opendaylight.yangtools.yang.model.api.SchemaPath path)

addRpcInput

public ContainerSchemaNodeBuilder addRpcInput(int line,
                                     org.opendaylight.yangtools.yang.common.QName qname,
                                     org.opendaylight.yangtools.yang.model.api.SchemaPath schemaPath)

addRpcOutput

public ContainerSchemaNodeBuilder addRpcOutput(org.opendaylight.yangtools.yang.model.api.SchemaPath schemaPath,
                                      org.opendaylight.yangtools.yang.common.QName qname,
                                      int line)

addNotification

public void addNotification(org.opendaylight.yangtools.yang.model.api.NotificationDefinition notification)

addNotification

public NotificationBuilder addNotification(int line,
                                  org.opendaylight.yangtools.yang.common.QName qname,
                                  org.opendaylight.yangtools.yang.model.api.SchemaPath path)

addFeature

public FeatureBuilder addFeature(int line,
                        org.opendaylight.yangtools.yang.common.QName qname,
                        org.opendaylight.yangtools.yang.model.api.SchemaPath path)

addChoice

public ChoiceBuilder addChoice(int line,
                      org.opendaylight.yangtools.yang.common.QName qname,
                      org.opendaylight.yangtools.yang.model.api.SchemaPath path)

addCase

public ChoiceCaseBuilder addCase(int line,
                        org.opendaylight.yangtools.yang.common.QName qname,
                        org.opendaylight.yangtools.yang.model.api.SchemaPath path)

addAnyXml

public AnyXmlBuilder addAnyXml(int line,
                      org.opendaylight.yangtools.yang.common.QName qname,
                      org.opendaylight.yangtools.yang.model.api.SchemaPath schemaPath)

addTypedef

public void addTypedef(TypeDefinitionBuilder typedefBuilder)

Description copied from interface: DataNodeContainerBuilder

Add typedef builder to this node.

Specified by:

addTypedef in interface DataNodeContainerBuilder

Overrides:

addTypedef in class AbstractDocumentedDataNodeContainerBuilder

Parameters:

typedefBuilder - Builder to add to this node.

addTypedef

public TypeDefinitionBuilderImpl addTypedef(int line,
                                   org.opendaylight.yangtools.yang.common.QName qname,
                                   org.opendaylight.yangtools.yang.model.api.SchemaPath path)

setType

public void setType(org.opendaylight.yangtools.yang.model.api.TypeDefinition<?> type)

addUnionType

public UnionTypeBuilder addUnionType(int line,
                            org.opendaylight.yangtools.yang.common.QNameModule module)

addIdentityrefType

public void addIdentityrefType(int line,
                      org.opendaylight.yangtools.yang.model.api.SchemaPath schemaPath,
                      String baseString)

addDeviation

public DeviationBuilder addDeviation(int line,
                            org.opendaylight.yangtools.yang.model.api.SchemaPath targetPath)

addIdentity

public IdentitySchemaNodeBuilder addIdentity(org.opendaylight.yangtools.yang.common.QName qname,
                                    int line,
                                    org.opendaylight.yangtools.yang.model.api.SchemaPath path)

addUnknownNodeBuilder

public void addUnknownNodeBuilder(UnknownSchemaNodeBuilder builder)

Description copied from interface: Builder

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

Specified by:

addUnknownNodeBuilder in interface Builder

Overrides:

addUnknownNodeBuilder in class AbstractBuilder

addUnknownSchemaNode

public UnknownSchemaNodeBuilderImpl addUnknownSchemaNode(int line,
                                                org.opendaylight.yangtools.yang.common.QName qname,
                                                org.opendaylight.yangtools.yang.model.api.SchemaPath path)

getRpcs

public Set<org.opendaylight.yangtools.yang.model.api.RpcDefinition> getRpcs()

getAddedRpcs

public Set<RpcDefinitionBuilder> getAddedRpcs()

getNotifications

public Set<org.opendaylight.yangtools.yang.model.api.NotificationDefinition> getNotifications()

getAddedNotifications

public Set<NotificationBuilder> getAddedNotifications()

toString

public String toString()

Overrides:

toString in class Object

setSource

public void setSource(com.google.common.io.ByteSource byteSource)
               throws IOException

Throws:

IOException

setSource

public void setSource(String source)

getYangVersion

public String getYangVersion()

getContact

public String getContact()

getOrganization

public String getOrganization()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getExtensionInstances

public List<org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode> getExtensionInstances()