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

Class BuilderUtils

java.lang.Object

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

public final class BuilderUtils
extends Object

Method Summary

Methods

Modifier and Type	Method and Description
static org.opendaylight.yangtools.yang.model.api.SchemaPath	createSchemaPath(org.opendaylight.yangtools.yang.model.api.SchemaPath schemaPath, org.opendaylight.yangtools.yang.common.QName... qname) Deprecated. Use SchemaPath.createChild(QName...) instead.
static Map<String,TreeMap<Date,URI>>	createYangNamespaceContext(Collection<? extends org.antlr.v4.runtime.tree.ParseTree> modules, com.google.common.base.Optional<org.opendaylight.yangtools.yang.model.api.SchemaContext> context)
static Collection<com.google.common.io.ByteSource>	filesToByteSources(Collection<File> streams)
static com.google.common.io.ByteSource	fileToByteSource(File file)
static void	fillAugmentTarget(AugmentationSchemaBuilder augment, Builder target) Add all augment's child nodes to given target.
static IdentitySchemaNodeBuilder	findBaseIdentity(ModuleBuilder module, String baseString, int line)
static IdentitySchemaNodeBuilder	findIdentity(Set<IdentitySchemaNodeBuilder> identities, String name)
static ModuleBuilder	findModule(org.opendaylight.yangtools.yang.common.QName qname, Map<URI,TreeMap<Date,ModuleBuilder>> modules)
static ModuleBuilder	findModuleFromBuilders(Map<String,TreeMap<Date,ModuleBuilder>> modules, ModuleBuilder module, String prefix, int line) Find dependent module based on given prefix
static ModuleBuilder	findModuleFromBuilders(org.opendaylight.yangtools.yang.model.api.ModuleImport imp, Iterable<ModuleBuilder> modules)
static org.opendaylight.yangtools.yang.model.api.Module	findModuleFromContext(org.opendaylight.yangtools.yang.model.api.SchemaContext context, ModuleBuilder currentModule, String prefix, int line) Find module from context based on prefix.
static SchemaNodeBuilder	findSchemaNode(Iterable<org.opendaylight.yangtools.yang.common.QName> path, SchemaNodeBuilder parentNode)
static com.google.common.base.Optional<SchemaNodeBuilder>	findSchemaNodeInModule(org.opendaylight.yangtools.yang.model.api.SchemaPath schemaPath, ModuleBuilder module) Find a builder for node in data namespace of YANG module.
static ModuleBuilder	getModuleByPrefix(ModuleBuilder module, String prefix)
static ModuleBuilder	getParentModule(Builder node) Get module in which this node is defined.
static boolean	processAugmentation(AugmentationSchemaBuilder augment, ModuleBuilder firstNodeParent) Find augment target node and perform augmentation.
static void	setNodeAddedByUses(GroupingMember node) Set addedByUses flag to true for node and all its child nodes.
static Collection<com.google.common.io.ByteSource>	streamsToByteSources(Collection<InputStream> streams)
static DataSchemaNodeBuilder	wrapChildNode(String moduleName, int line, org.opendaylight.yangtools.yang.model.api.DataSchemaNode node, org.opendaylight.yangtools.yang.model.api.SchemaPath parentPath, org.opendaylight.yangtools.yang.common.QName qname)
static Set<DataSchemaNodeBuilder>	wrapChildNodes(String moduleName, int line, Collection<org.opendaylight.yangtools.yang.model.api.DataSchemaNode> nodes, org.opendaylight.yangtools.yang.model.api.SchemaPath parentPath, org.opendaylight.yangtools.yang.common.QName parentQName)
static Set<GroupingBuilder>	wrapGroupings(String moduleName, int line, Set<org.opendaylight.yangtools.yang.model.api.GroupingDefinition> nodes, org.opendaylight.yangtools.yang.model.api.SchemaPath parentPath, org.opendaylight.yangtools.yang.common.QName parentQName)
static Set<TypeDefinitionBuilder>	wrapTypedefs(String moduleName, int line, org.opendaylight.yangtools.yang.model.api.DataNodeContainer dataNode, org.opendaylight.yangtools.yang.model.api.SchemaPath parentPath, org.opendaylight.yangtools.yang.common.QName parentQName)
static List<UnknownSchemaNodeBuilderImpl>	wrapUnknownNodes(String moduleName, int line, List<org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode> nodes, org.opendaylight.yangtools.yang.model.api.SchemaPath parentPath, org.opendaylight.yangtools.yang.common.QName parentQName)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

streamsToByteSources

public static Collection<com.google.common.io.ByteSource> streamsToByteSources(Collection<InputStream> streams)
                                                                        throws IOException

Throws:

IOException

fileToByteSource

public static com.google.common.io.ByteSource fileToByteSource(File file)

filesToByteSources

public static Collection<com.google.common.io.ByteSource> filesToByteSources(Collection<File> streams)
                                                                      throws FileNotFoundException

Throws:

FileNotFoundException

createSchemaPath

@Deprecated
public static org.opendaylight.yangtools.yang.model.api.SchemaPath createSchemaPath(org.opendaylight.yangtools.yang.model.api.SchemaPath schemaPath,
                                                                               org.opendaylight.yangtools.yang.common.QName... qname)

Deprecated. Use SchemaPath.createChild(QName...) instead.

Create new SchemaPath from given path and qname.

Parameters:

schemaPath - base path

qname - one or more qnames added to base path

Returns:

new SchemaPath from given path and qname

findModuleFromBuilders

public static ModuleBuilder findModuleFromBuilders(Map<String,TreeMap<Date,ModuleBuilder>> modules,
                                   ModuleBuilder module,
                                   String prefix,
                                   int line)

Find dependent module based on given prefix

Parameters:

modules - all available modules

module - current module

prefix - target module prefix

line - current line in yang model

Returns:

module builder if found, null otherwise

findModuleFromBuilders

public static ModuleBuilder findModuleFromBuilders(org.opendaylight.yangtools.yang.model.api.ModuleImport imp,
                                   Iterable<ModuleBuilder> modules)

findModuleFromContext

public static org.opendaylight.yangtools.yang.model.api.Module findModuleFromContext(org.opendaylight.yangtools.yang.model.api.SchemaContext context,
                                                                     ModuleBuilder currentModule,
                                                                     String prefix,
                                                                     int line)

Find module from context based on prefix.

Parameters:

context - schema context

currentModule - current module

prefix - prefix used to reference dependent module

line - current line in yang model

Returns:

module based on import with given prefix if found in context, null otherwise

Throws:

YangParseException - if no import found with given prefix

fillAugmentTarget

public static void fillAugmentTarget(AugmentationSchemaBuilder augment,
                     Builder target)

Add all augment's child nodes to given target.

Parameters:

augment - builder of augment statement

target - augmentation target node

setNodeAddedByUses

public static void setNodeAddedByUses(GroupingMember node)

Set addedByUses flag to true for node and all its child nodes.

Parameters:

node -

findSchemaNode

public static SchemaNodeBuilder findSchemaNode(Iterable<org.opendaylight.yangtools.yang.common.QName> path,
                               SchemaNodeBuilder parentNode)

findSchemaNodeInModule

public static com.google.common.base.Optional<SchemaNodeBuilder> findSchemaNodeInModule(org.opendaylight.yangtools.yang.model.api.SchemaPath schemaPath,
                                                                        ModuleBuilder module)

Find a builder for node in data namespace of YANG module. Search is performed on full QName equals, this means builders and schema path MUST be resolved against imports and their namespaces. Search is done in data namespace, this means notification, rpc definitions and top level data definitions are considered as top-level items, from which it is possible to traverse.

Parameters:

schemaPath - Schema Path to node

module - ModuleBuilder to start lookup in

Returns:

Node Builder if found, Optional.absent() otherwise.

processAugmentation

public static boolean processAugmentation(AugmentationSchemaBuilder augment,
                          ModuleBuilder firstNodeParent)

Find augment target node and perform augmentation.

Parameters:

augment - augment builder to process

firstNodeParent - parent of first node in path

Returns:

true if augmentation process succeed, false otherwise

findBaseIdentity

public static IdentitySchemaNodeBuilder findBaseIdentity(ModuleBuilder module,
                                         String baseString,
                                         int line)

findIdentity

public static IdentitySchemaNodeBuilder findIdentity(Set<IdentitySchemaNodeBuilder> identities,
                                     String name)

getParentModule

public static ModuleBuilder getParentModule(Builder node)

Get module in which this node is defined.

Parameters:

node -

Returns:

builder of module where this node is defined

wrapChildNodes

public static Set<DataSchemaNodeBuilder> wrapChildNodes(String moduleName,
                                        int line,
                                        Collection<org.opendaylight.yangtools.yang.model.api.DataSchemaNode> nodes,
                                        org.opendaylight.yangtools.yang.model.api.SchemaPath parentPath,
                                        org.opendaylight.yangtools.yang.common.QName parentQName)

wrapChildNode

public static DataSchemaNodeBuilder wrapChildNode(String moduleName,
                                  int line,
                                  org.opendaylight.yangtools.yang.model.api.DataSchemaNode node,
                                  org.opendaylight.yangtools.yang.model.api.SchemaPath parentPath,
                                  org.opendaylight.yangtools.yang.common.QName qname)

wrapGroupings

public static Set<GroupingBuilder> wrapGroupings(String moduleName,
                                 int line,
                                 Set<org.opendaylight.yangtools.yang.model.api.GroupingDefinition> nodes,
                                 org.opendaylight.yangtools.yang.model.api.SchemaPath parentPath,
                                 org.opendaylight.yangtools.yang.common.QName parentQName)

wrapTypedefs

public static Set<TypeDefinitionBuilder> wrapTypedefs(String moduleName,
                                      int line,
                                      org.opendaylight.yangtools.yang.model.api.DataNodeContainer dataNode,
                                      org.opendaylight.yangtools.yang.model.api.SchemaPath parentPath,
                                      org.opendaylight.yangtools.yang.common.QName parentQName)

wrapUnknownNodes

public static List<UnknownSchemaNodeBuilderImpl> wrapUnknownNodes(String moduleName,
                                                  int line,
                                                  List<org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode> nodes,
                                                  org.opendaylight.yangtools.yang.model.api.SchemaPath parentPath,
                                                  org.opendaylight.yangtools.yang.common.QName parentQName)

getModuleByPrefix

public static ModuleBuilder getModuleByPrefix(ModuleBuilder module,
                              String prefix)

findModule

public static ModuleBuilder findModule(org.opendaylight.yangtools.yang.common.QName qname,
                       Map<URI,TreeMap<Date,ModuleBuilder>> modules)

createYangNamespaceContext

public static Map<String,TreeMap<Date,URI>> createYangNamespaceContext(Collection<? extends org.antlr.v4.runtime.tree.ParseTree> modules,
                                                       com.google.common.base.Optional<org.opendaylight.yangtools.yang.model.api.SchemaContext> context)