2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
\r
4 * This program and the accompanying materials are made available under the
\r
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
\r
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
\r
8 package org.opendaylight.yangtools.sal.binding.generator.impl;
10 import java.util.ArrayList;
11 import java.util.Collections;
12 import java.util.HashMap;
13 import java.util.List;
16 import org.opendaylight.yangtools.binding.generator.util.BindingTypes;
17 import org.opendaylight.yangtools.binding.generator.util.ReferencedTypeImpl;
18 import org.opendaylight.yangtools.binding.generator.util.Types;
19 import org.opendaylight.yangtools.binding.generator.util.generated.type.builder.GeneratedTOBuilderImpl;
20 import org.opendaylight.yangtools.binding.generator.util.generated.type.builder.GeneratedTypeBuilderImpl;
21 import org.opendaylight.yangtools.sal.binding.generator.api.BindingGenerator;
22 import org.opendaylight.yangtools.sal.binding.generator.spi.TypeProvider;
23 import org.opendaylight.yangtools.sal.binding.model.api.AccessModifier;
24 import org.opendaylight.yangtools.sal.binding.model.api.Type;
25 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.EnumBuilder;
26 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedTOBuilder;
27 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedTypeBuilder;
28 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.MethodSignatureBuilder;
29 import org.opendaylight.yangtools.sal.binding.yang.types.GroupingDefinitionDependencySort;
30 import org.opendaylight.yangtools.sal.binding.yang.types.TypeProviderImpl;
31 import org.opendaylight.yangtools.yang.binding.RpcService;
32 import org.opendaylight.yangtools.yang.common.RpcResult;
33 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
34 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
35 import org.opendaylight.yangtools.yang.model.api.ChoiceNode;
36 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
37 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
38 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
39 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
40 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
41 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
42 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
43 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
44 import org.opendaylight.yangtools.yang.model.api.Module;
45 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
46 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
47 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
48 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
49 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
50 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
51 import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition;
52 import org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition;
53 import org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition;
54 import org.opendaylight.yangtools.yang.model.util.DataNodeIterator;
55 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
56 import org.opendaylight.yangtools.yang.model.util.UnionType;
57 import static com.google.common.base.Preconditions.*;
58 import static extension org.opendaylight.yangtools.binding.generator.util.Types.*;
59 import static org.opendaylight.yangtools.binding.generator.util.BindingGeneratorUtil.*;
60 import static org.opendaylight.yangtools.binding.generator.util.BindingTypes.*;
61 import static org.opendaylight.yangtools.yang.model.util.SchemaContextUtil.*;
62 import org.opendaylight.yangtools.yang.parser.util.ModuleDependencySort
63 import org.opendaylight.yangtools.yang.model.util.ExtendedType;
64 import org.opendaylight.yangtools.yang.model.api.UsesNode
65 import org.opendaylight.yangtools.yang.binding.annotations.RoutingContext
66 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.AnnotationTypeBuilder
67 import org.opendaylight.yangtools.yang.model.api.ModuleImport
68 import org.opendaylight.yangtools.yang.binding.DataContainer
69 import java.util.Iterator
70 import org.opendaylight.yangtools.yang.model.api.AugmentationTarget
71 import java.util.Collection
72 import org.opendaylight.yangtools.yang.model.api.YangNode
73 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition
74 import org.opendaylight.yangtools.binding.generator.util.BindingGeneratorUtil
75 import org.opendaylight.yangtools.sal.binding.model.api.Restrictions
76 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedPropertyBuilder
77 import org.opendaylight.yangtools.binding.generator.util.generated.type.builder.GeneratedPropertyBuilderImpl
78 import org.opendaylight.yangtools.yang.common.QName
\rimport org.opendaylight.yangtools.yang.binding.BindingMapping
79 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedTypeBuilderBase
81 public class BindingGeneratorImpl implements BindingGenerator {
83 private final Map<Module, ModuleContext> genCtx = new HashMap()
86 * Outter key represents the package name. Outter value represents map of
\r
87 * all builders in the same package. Inner key represents the schema node
\r
88 * name (in JAVA class/interface name format). Inner value represents
\r
89 * instance of builder for schema node specified in key part.
\r
91 private Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders;
94 * Provide methods for converting YANG types to JAVA types.
\r
96 private var TypeProvider typeProvider;
99 * Holds reference to schema context to resolve data of augmented elemnt
\r
100 * when creating augmentation builder
\r
102 private var SchemaContext schemaContext;
105 * Constant with the concrete name of namespace.
\r
107 private val static String YANG_EXT_NAMESPACE = "urn:opendaylight:yang:extension:yang-ext";
110 * Constant with the concrete name of identifier.
\r
112 private val static String AUGMENT_IDENTIFIER_NAME = "augment-identifier";
115 * Resolves generated types from <code>context</code> schema nodes of all
\r
118 * Generated types are created for modules, groupings, types, containers,
\r
119 * lists, choices, augments, rpcs, notification, identities.
\r
122 * schema context which contains data about all schema nodes
\r
124 * @return list of types (usually <code>GeneratedType</code>
\r
125 * <code>GeneratedTransferObject</code>which are generated from
\r
126 * <code>context</code> data.
\r
127 * @throws IllegalArgumentException
\r
128 * if param <code>context</code> is null
\r
129 * @throws IllegalStateException
\r
130 * if <code>context</code> contain no modules
\r
132 override generateTypes(SchemaContext context) {
133 checkArgument(context !== null, "Schema Context reference cannot be NULL.");
134 checkState(context.modules !== null, "Schema Context does not contain defined modules.");
135 schemaContext = context;
136 typeProvider = new TypeProviderImpl(context);
137 val Set<Module> modules = context.modules;
138 return generateTypes(context, modules);
142 * Resolves generated types from <code>context</code> schema nodes only for
\r
143 * modules specified in <code>modules</code>
\r
145 * Generated types are created for modules, groupings, types, containers,
\r
146 * lists, choices, augments, rpcs, notification, identities.
\r
149 * schema context which contains data about all schema nodes
\r
152 * set of modules for which schema nodes should be generated
\r
154 * @return list of types (usually <code>GeneratedType</code> or
\r
155 * <code>GeneratedTransferObject</code>) which:
\r
157 * <li>are generated from <code>context</code> schema nodes and</li>
\r
158 * <li>are also part of some of the module in <code>modules</code>
\r
161 * @throws IllegalArgumentException
\r
163 * <li>if param <code>context</code> is null or</li>
\r
164 * <li>if param <code>modules</code> is null</li>
\r
166 * @throws IllegalStateException
\r
167 * if <code>context</code> contain no modules
\r
169 override generateTypes(SchemaContext context, Set<Module> modules) {
170 checkArgument(context !== null, "Schema Context reference cannot be NULL.");
171 checkState(context.modules !== null, "Schema Context does not contain defined modules.");
172 checkArgument(modules !== null, "Set of Modules cannot be NULL.");
174 schemaContext = context;
175 typeProvider = new TypeProviderImpl(context);
176 val contextModules = ModuleDependencySort.sort(context.modules);
177 genTypeBuilders = new HashMap();
179 for (contextModule : contextModules) {
180 moduleToGenTypes(contextModule, context);
182 for (contextModule : contextModules) {
183 allAugmentsToGenTypes(contextModule);
186 val List<Type> filteredGenTypes = new ArrayList();
187 for (Module m : modules) {
188 filteredGenTypes.addAll(genCtx.get(m).generatedTypes);
193 return filteredGenTypes;
196 private def void moduleToGenTypes(Module m, SchemaContext context) {
197 genCtx.put(m, new ModuleContext)
198 allTypeDefinitionsToGenTypes(m)
199 groupingsToGenTypes(m, m.groupings)
200 rpcMethodsToGenType(m)
201 allIdentitiesToGenTypes(m, context)
202 notificationsToGenType(m)
204 if (!m.childNodes.isEmpty()) {
205 val moduleType = moduleToDataType(m)
206 genCtx.get(m).addModuleNode(moduleType)
207 val basePackageName = moduleNamespaceToPackageName(m);
208 resolveDataSchemaNodes(m, basePackageName, moduleType, moduleType, m.childNodes)
213 * Converts all extended type definitions of module to the list of
\r
214 * <code>Type</code> objects.
\r
217 * module from which is obtained set of type definitions
\r
218 * @throws IllegalArgumentException
\r
220 * <li>if module equals null</li>
\r
221 * <li>if name of module equals null</li>
\r
222 * <li>if type definitions of module equal null</li>
\r
226 private def void allTypeDefinitionsToGenTypes(Module module) {
227 checkArgument(module !== null, "Module reference cannot be NULL.");
228 checkArgument(module.name !== null, "Module name cannot be NULL.");
229 val it = new DataNodeIterator(module);
230 val List<TypeDefinition<?>> typeDefinitions = it.allTypedefs;
231 checkState(typeDefinitions !== null, '''Type Definitions for module «module.name» cannot be NULL.''');
233 for (TypeDefinition<?> typedef : typeDefinitions) {
234 if (typedef !== null) {
235 val type = (typeProvider as TypeProviderImpl).generatedTypeForExtendedDefinitionType(typedef, typedef);
237 genCtx.get(module).addTypedefType(typedef.path, type)
243 private def GeneratedTypeBuilder processDataSchemaNode(Module module, String basePackageName,
244 GeneratedTypeBuilder parent, GeneratedTypeBuilder childOf, DataSchemaNode node) {
245 if (node.augmenting || node.addedByUses) {
248 val packageName = packageNameForGeneratedType(basePackageName, node.path)
249 val genType = addDefaultInterfaceDefinition(packageName, node, childOf)
250 if (node instanceof DataNodeContainer) {
251 genCtx.get(module).addChildNodeType(node.path, genType)
252 groupingsToGenTypes(module, (node as DataNodeContainer).groupings)
253 processUsesAugments(node as DataNodeContainer, module)
258 private def void containerToGenType(Module module, String basePackageName, GeneratedTypeBuilder parent,
259 GeneratedTypeBuilder childOf, ContainerSchemaNode node) {
260 val genType = processDataSchemaNode(module, basePackageName, parent, childOf, node)
261 if (genType != null) {
262 constructGetter(parent, node.QName.localName, node.description, genType)
263 resolveDataSchemaNodes(module, basePackageName, genType, genType, node.childNodes)
267 private def void listToGenType(Module module, String basePackageName, GeneratedTypeBuilder parent,
268 GeneratedTypeBuilder childOf, ListSchemaNode node) {
269 val genType = processDataSchemaNode(module, basePackageName, parent, childOf, node)
270 if (genType != null) {
271 constructGetter(parent, node.QName.localName, node.description, Types.listTypeFor(genType))
273 val List<String> listKeys = listKeys(node);
274 val packageName = packageNameForGeneratedType(basePackageName, (node).path)
275 val genTOBuilder = resolveListKeyTOBuilder(packageName, node);
276 if (genTOBuilder !== null) {
277 val identifierMarker = IDENTIFIER.parameterizedTypeFor(genType);
278 val identifiableMarker = IDENTIFIABLE.parameterizedTypeFor(genTOBuilder);
279 genTOBuilder.addImplementsType(identifierMarker);
280 genType.addImplementsType(identifiableMarker);
283 for (schemaNode : node.childNodes) {
284 if (!schemaNode.augmenting) {
285 addSchemaNodeToListBuilders(basePackageName, schemaNode, genType, genTOBuilder, listKeys, module);
289 // serialVersionUID
\r
290 if (genTOBuilder !== null) {
291 val GeneratedPropertyBuilder prop = new GeneratedPropertyBuilderImpl("serialVersionUID");
292 prop.setValue(Long.toString(computeDefaultSUID(genTOBuilder as GeneratedTOBuilderImpl)));
293 genTOBuilder.setSUID(prop);
296 typeBuildersToGenTypes(module, genType, genTOBuilder);
300 private def void processUsesAugments(DataNodeContainer node, Module module) {
301 val basePackageName = moduleNamespaceToPackageName(module);
302 for (usesNode : node.uses) {
303 for (augment : usesNode.augmentations) {
304 augmentationToGenTypes(basePackageName, augment, module, usesNode);
305 processUsesAugments(augment, module);
311 * Converts all <b>augmentation</b> of the module to the list
\r
312 * <code>Type</code> objects.
\r
315 * module from which is obtained list of all augmentation objects
\r
316 * to iterate over them
\r
317 * @throws IllegalArgumentException
\r
319 * <li>if the module equals null</li>
\r
320 * <li>if the name of module equals null</li>
\r
321 * <li>if the set of child nodes equals null</li>
\r
325 private def void allAugmentsToGenTypes(Module module) {
326 checkArgument(module !== null, "Module reference cannot be NULL.");
327 checkArgument(module.name !== null, "Module name cannot be NULL.");
328 if (module.childNodes === null) {
329 throw new IllegalArgumentException(
330 "Reference to Set of Augmentation Definitions in module " + module.name + " cannot be NULL.");
333 val basePackageName = moduleNamespaceToPackageName(module);
334 val List<AugmentationSchema> augmentations = resolveAugmentations(module);
335 for (augment : augmentations) {
336 augmentationToGenTypes(basePackageName, augment, module, null);
341 * Returns list of <code>AugmentationSchema</code> objects. The objects are
\r
342 * sorted according to the length of their target path from the shortest to
\r
346 * module from which is obtained list of all augmentation objects
\r
347 * @return list of sorted <code>AugmentationSchema</code> objects obtained
\r
348 * from <code>module</code>
\r
349 * @throws IllegalArgumentException
\r
351 * <li>if the module equals null</li>
\r
352 * <li>if the set of augmentation equals null</li>
\r
356 private def List<AugmentationSchema> resolveAugmentations(Module module) {
357 checkArgument(module !== null, "Module reference cannot be NULL.");
358 checkState(module.augmentations !== null, "Augmentations Set cannot be NULL.");
360 val Set<AugmentationSchema> augmentations = module.augmentations;
361 val List<AugmentationSchema> sortedAugmentations = new ArrayList(augmentations);
362 Collections.sort(sortedAugmentations,
363 [ augSchema1, augSchema2 |
364 if (augSchema1.targetPath.path.size() > augSchema2.targetPath.path.size()) {
366 } else if (augSchema1.targetPath.path.size() < augSchema2.targetPath.path.size()) {
371 return sortedAugmentations;
375 * Converts whole <b>module</b> to <code>GeneratedType</code> object.
\r
376 * Firstly is created the module builder object from which is vally
\r
377 * obtained reference to <code>GeneratedType</code> object.
\r
380 * module from which are obtained the module name, child nodes,
\r
381 * uses and is derived package name
\r
382 * @return <code>GeneratedType</code> which is internal representation of
\r
384 * @throws IllegalArgumentException
\r
385 * if the module equals null
\r
388 private def GeneratedTypeBuilder moduleToDataType(Module module) {
389 checkArgument(module !== null, "Module reference cannot be NULL.");
391 val moduleDataTypeBuilder = moduleTypeBuilder(module, "Data");
392 addImplementedInterfaceFromUses(module, moduleDataTypeBuilder);
393 moduleDataTypeBuilder.addImplementsType(DATA_ROOT);
394 return moduleDataTypeBuilder;
398 * Converts all <b>rpcs</b> inputs and outputs substatements of the module
\r
399 * to the list of <code>Type</code> objects. In addition are to containers
\r
400 * and lists which belong to input or output also part of returning list.
\r
403 * module from which is obtained set of all rpc objects to
\r
404 * iterate over them
\r
405 * @throws IllegalArgumentException
\r
407 * <li>if the module equals null</li>
\r
408 * <li>if the name of module equals null</li>
\r
409 * <li>if the set of child nodes equals null</li>
\r
413 private def void rpcMethodsToGenType(Module module) {
414 checkArgument(module !== null, "Module reference cannot be NULL.");
415 checkArgument(module.name !== null, "Module name cannot be NULL.");
416 checkArgument(module.childNodes !== null,
417 "Reference to Set of RPC Method Definitions in module " + module.name + " cannot be NULL.");
419 val basePackageName = moduleNamespaceToPackageName(module);
420 val Set<RpcDefinition> rpcDefinitions = module.rpcs;
421 if (rpcDefinitions.isEmpty()) {
425 val interfaceBuilder = moduleTypeBuilder(module, "Service");
426 interfaceBuilder.addImplementsType(Types.typeForClass(RpcService));
427 for (rpc : rpcDefinitions) {
429 val rpcName = BindingMapping.getClassName(rpc.QName);
430 val rpcMethodName = parseToValidParamName(rpcName);
431 val method = interfaceBuilder.addMethod(rpcMethodName);
432 val input = rpc.input;
433 val output = rpc.output;
435 if (input !== null) {
436 val inType = addRawInterfaceDefinition(basePackageName, input, rpcName);
437 addImplementedInterfaceFromUses(input, inType);
438 inType.addImplementsType(DATA_OBJECT);
439 inType.addImplementsType(augmentable(inType));
440 resolveDataSchemaNodes(module, basePackageName, inType, inType, input.childNodes);
441 genCtx.get(module).addChildNodeType(input.path, inType)
442 val inTypeInstance = inType.toInstance();
443 method.addParameter(inTypeInstance, "input");
446 var Type outTypeInstance = VOID;
447 if (output !== null) {
448 val outType = addRawInterfaceDefinition(basePackageName, output, rpcName);
449 addImplementedInterfaceFromUses(output, outType);
450 outType.addImplementsType(DATA_OBJECT);
451 outType.addImplementsType(augmentable(outType));
452 resolveDataSchemaNodes(module, basePackageName, outType, outType, output.childNodes);
453 genCtx.get(module).addChildNodeType(output.path, outType)
454 outTypeInstance = outType.toInstance();
457 val rpcRes = Types.parameterizedTypeFor(Types.typeForClass(RpcResult), outTypeInstance);
458 method.setReturnType(Types.parameterizedTypeFor(FUTURE, rpcRes));
462 genCtx.get(module).addTopLevelNodeType(interfaceBuilder)
466 * Converts all <b>notifications</b> of the module to the list of
\r
467 * <code>Type</code> objects. In addition are to this list added containers
\r
468 * and lists which are part of this notification.
\r
471 * module from which is obtained set of all notification objects
\r
472 * to iterate over them
\r
473 * @throws IllegalArgumentException
\r
475 * <li>if the module equals null</li>
\r
476 * <li>if the name of module equals null</li>
\r
477 * <li>if the set of child nodes equals null</li>
\r
481 private def void notificationsToGenType(Module module) {
482 checkArgument(module !== null, "Module reference cannot be NULL.");
483 checkArgument(module.name !== null, "Module name cannot be NULL.");
485 if (module.childNodes === null) {
486 throw new IllegalArgumentException(
487 "Reference to Set of Notification Definitions in module " + module.name + " cannot be NULL.");
489 val notifications = module.notifications;
490 if(notifications.empty) return;
492 val listenerInterface = moduleTypeBuilder(module, "Listener");
493 listenerInterface.addImplementsType(BindingTypes.NOTIFICATION_LISTENER);
494 val basePackageName = moduleNamespaceToPackageName(module);
496 for (notification : notifications) {
497 if (notification !== null) {
498 processUsesAugments(notification, module);
500 val notificationInterface = addDefaultInterfaceDefinition(basePackageName, notification,
501 BindingTypes.DATA_OBJECT);
502 notificationInterface.addImplementsType(NOTIFICATION);
503 genCtx.get(module).addChildNodeType(notification.path, notificationInterface)
505 // Notification object
\r
506 resolveDataSchemaNodes(module, basePackageName, notificationInterface, notificationInterface,
507 notification.childNodes);
509 listenerInterface.addMethod("on" + notificationInterface.name) //
\r
510 .setAccessModifier(AccessModifier.PUBLIC).addParameter(notificationInterface, "notification").
511 setReturnType(Types.VOID);
515 genCtx.get(module).addTopLevelNodeType(listenerInterface)
519 * Converts all <b>identities</b> of the module to the list of
\r
520 * <code>Type</code> objects.
\r
523 * module from which is obtained set of all identity objects to
\r
524 * iterate over them
\r
526 * schema context only used as input parameter for method
\r
527 * {@link identityToGenType}
\r
530 private def void allIdentitiesToGenTypes(Module module, SchemaContext context) {
531 val Set<IdentitySchemaNode> schemaIdentities = module.identities;
532 val basePackageName = moduleNamespaceToPackageName(module);
534 if (schemaIdentities !== null && !schemaIdentities.isEmpty()) {
535 for (identity : schemaIdentities) {
536 identityToGenType(module, basePackageName, identity, context);
542 * Converts the <b>identity</b> object to GeneratedType. Firstly it is
\r
543 * created transport object builder. If identity contains base identity then
\r
544 * reference to base identity is added to superior identity as its extend.
\r
545 * If identity doesn't contain base identity then only reference to abstract
\r
546 * class {@link org.opendaylight.yangtools.yang.model.api.BaseIdentity
\r
547 * BaseIdentity} is added
\r
549 * @param module current module
\r
550 * @param basePackageName
\r
551 * string contains the module package name
\r
553 * IdentitySchemaNode which contains data about identity
\r
555 * SchemaContext which is used to get package and name
\r
556 * information about base of identity
\r
559 private def void identityToGenType(Module module, String basePackageName, IdentitySchemaNode identity,
560 SchemaContext context) {
561 if (identity === null) {
564 val packageName = packageNameForGeneratedType(basePackageName, identity.path);
565 val genTypeName = BindingMapping.getClassName(identity.QName);
566 val newType = new GeneratedTOBuilderImpl(packageName, genTypeName);
567 val baseIdentity = identity.baseIdentity;
568 if (baseIdentity === null) {
569 newType.setExtendsType(Types.baseIdentityTO);
571 val baseIdentityParentModule = SchemaContextUtil.findParentModule(context, baseIdentity);
572 val returnTypePkgName = moduleNamespaceToPackageName(baseIdentityParentModule);
573 val returnTypeName = BindingMapping.getClassName(baseIdentity.QName);
574 val gto = new GeneratedTOBuilderImpl(returnTypePkgName, returnTypeName).toInstance();
575 newType.setExtendsType(gto);
577 newType.setAbstract(true);
\r
578 val qname = identity.QName;
\r
580 newType.qnameConstant(BindingMapping.QNAME_STATIC_FIELD_NAME,qname);
\r
582 genCtx.get(module).addIdentityType(identity.QName,newType)
585 private static def qnameConstant(GeneratedTypeBuilderBase<?> toBuilder, String constantName, QName name) {
586 toBuilder.addConstant(QName.typeForClass,constantName,'''
\r
587 org.opendaylight.yangtools.yang.common.QName.create("«name.namespace»","«name.formattedRevision»","«name.localName»")
\r
592 * Converts all <b>groupings</b> of the module to the list of
\r
593 * <code>Type</code> objects. Firstly are groupings sorted according mutual
\r
594 * dependencies. At least dependend (indepedent) groupings are in the list
\r
595 * saved at first positions. For every grouping the record is added to map
\r
596 * {@link BindingGeneratorImpl#allGroupings allGroupings}
\r
600 * @param collection of groupings from which types will be generated
\r
603 private def void groupingsToGenTypes(Module module, Collection<GroupingDefinition> groupings) {
604 val basePackageName = moduleNamespaceToPackageName(module);
605 val List<GroupingDefinition> groupingsSortedByDependencies = new GroupingDefinitionDependencySort().sort(
607 for (grouping : groupingsSortedByDependencies) {
608 groupingToGenType(basePackageName, grouping, module);
613 * Converts individual grouping to GeneratedType. Firstly generated type
\r
614 * builder is created and every child node of grouping is resolved to the
\r
617 * @param basePackageName
\r
618 * string contains the module package name
\r
620 * GroupingDefinition which contains data about grouping
\r
621 * @param module current module
\r
622 * @return GeneratedType which is generated from grouping (object of type
\r
623 * <code>GroupingDefinition</code>)
\r
625 private def void groupingToGenType(String basePackageName, GroupingDefinition grouping, Module module) {
626 val packageName = packageNameForGeneratedType(basePackageName, grouping.path);
627 val genType = addDefaultInterfaceDefinition(packageName, grouping);
628 genCtx.get(module).addGroupingType(grouping.path, genType)
629 resolveDataSchemaNodes(module, basePackageName, genType, genType, grouping.childNodes);
630 groupingsToGenTypes(module, grouping.groupings);
631 processUsesAugments(grouping, module);
635 * Tries to find EnumTypeDefinition in <code>typeDefinition</code>. If base
\r
636 * type of <code>typeDefinition</code> is of the type ExtendedType then this
\r
637 * method is recursivelly called with this base type.
\r
639 * @param typeDefinition
\r
640 * TypeDefinition in which should be EnumTypeDefinition found as
\r
642 * @return EnumTypeDefinition if it is found inside
\r
643 * <code>typeDefinition</code> or <code>null</code> in other case
\r
645 private def EnumTypeDefinition enumTypeDefFromExtendedType(TypeDefinition<?> typeDefinition) {
646 if (typeDefinition !== null) {
647 if (typeDefinition.baseType instanceof EnumTypeDefinition) {
648 return typeDefinition.baseType as EnumTypeDefinition;
649 } else if (typeDefinition.baseType instanceof ExtendedType) {
650 return enumTypeDefFromExtendedType(typeDefinition.baseType);
657 * Adds enumeration builder created from <code>enumTypeDef</code> to
\r
658 * <code>typeBuilder</code>.
\r
660 * Each <code>enumTypeDef</code> item is added to builder with its name and
\r
663 * @param enumTypeDef
\r
664 * EnumTypeDefinition contains enum data
\r
666 * string contains name which will be assigned to enumeration
\r
668 * @param typeBuilder
\r
669 * GeneratedTypeBuilder to which will be enum builder assigned
\r
670 * @return enumeration builder which contais data from
\r
671 * <code>enumTypeDef</code>
\r
673 private def EnumBuilder resolveInnerEnumFromTypeDefinition(EnumTypeDefinition enumTypeDef, QName enumName,
674 GeneratedTypeBuilder typeBuilder) {
675 if ((enumTypeDef !== null) && (typeBuilder !== null) && (enumTypeDef.QName !== null) &&
676 (enumTypeDef.QName.localName !== null)) {
677 val enumerationName = BindingMapping.getClassName(enumName);
678 val enumBuilder = typeBuilder.addEnumeration(enumerationName);
679 enumBuilder.updateEnumPairsFromEnumTypeDef(enumTypeDef);
686 * Generates type builder for <code>module</code>.
\r
689 * Module which is source of package name for generated type
\r
692 * string which is added to the module class name representation
\r
694 * @return instance of GeneratedTypeBuilder which represents
\r
695 * <code>module</code>.
\r
696 * @throws IllegalArgumentException
\r
697 * if <code>module</code> equals null
\r
699 private def GeneratedTypeBuilder moduleTypeBuilder(Module module, String postfix) {
700 checkArgument(module !== null, "Module reference cannot be NULL.");
701 val packageName = moduleNamespaceToPackageName(module);
702 val moduleName = BindingMapping.getClassName(module.name) + postfix;
703 return new GeneratedTypeBuilderImpl(packageName, moduleName);
707 * Converts <code>augSchema</code> to list of <code>Type</code> which
\r
708 * contains generated type for augmentation. In addition there are also
\r
709 * generated types for all containers, list and choices which are child of
\r
710 * <code>augSchema</code> node or a generated types for cases are added if
\r
711 * augmented node is choice.
\r
713 * @param augmentPackageName
\r
714 * string with the name of the package to which the augmentation
\r
717 * AugmentationSchema which is contains data about agumentation
\r
718 * (target path, childs...)
\r
719 * @param module current module
\r
720 * @param parentUsesNode parent uses node of this augment (can be null if this augment is not defined under uses statement)
\r
721 * @throws IllegalArgumentException
\r
723 * <li>if <code>augmentPackageName</code> equals null</li>
\r
724 * <li>if <code>augSchema</code> equals null</li>
\r
725 * <li>if target path of <code>augSchema</code> equals null</li>
\r
728 private def void augmentationToGenTypes(String augmentPackageName, AugmentationSchema augSchema, Module module,
729 UsesNode parentUsesNode) {
730 checkArgument(augmentPackageName !== null, "Package Name cannot be NULL.");
731 checkArgument(augSchema !== null, "Augmentation Schema cannot be NULL.");
732 checkState(augSchema.targetPath !== null,
733 "Augmentation Schema does not contain Target Path (Target Path is NULL).");
735 processUsesAugments(augSchema, module);
737 // EVERY augmented interface will extends Augmentation<T> interface
\r
738 // and DataObject interface
\r
739 val targetPath = augSchema.targetPath;
740 var targetSchemaNode = findDataSchemaNode(schemaContext, targetPath);
741 if (targetSchemaNode instanceof DataSchemaNode && (targetSchemaNode as DataSchemaNode).isAddedByUses()) {
742 if (parentUsesNode == null) {
743 targetSchemaNode = findOriginal(targetSchemaNode as DataSchemaNode);
745 targetSchemaNode = findOriginalTargetFromGrouping(targetSchemaNode.QName.localName, parentUsesNode);
747 if (targetSchemaNode == null) {
748 throw new NullPointerException(
749 "Failed to find target node from grouping for augmentation " + augSchema + " in module " +
754 if (targetSchemaNode !== null) {
755 var targetTypeBuilder = findChildNodeByPath(targetSchemaNode.path)
756 if (targetTypeBuilder === null) {
757 targetTypeBuilder = findCaseByPath(targetSchemaNode.path)
759 if (targetTypeBuilder === null) {
760 throw new NullPointerException("Target type not yet generated: " + targetSchemaNode);
762 if (!(targetSchemaNode instanceof ChoiceNode)) {
763 var packageName = augmentPackageName;
764 if (parentUsesNode != null) {
765 packageName = packageNameForGeneratedType(augmentPackageName, augSchema.targetPath);
767 val augTypeBuilder = addRawAugmentGenTypeDefinition(module, packageName, augmentPackageName,
768 targetTypeBuilder.toInstance, augSchema);
769 genCtx.get(module).addAugmentType(augTypeBuilder)
\r
770 genCtx.get(module).addTypeToAugmentation(augTypeBuilder,augSchema);
772 generateTypesFromAugmentedChoiceCases(module, augmentPackageName, targetTypeBuilder.toInstance,
773 targetSchemaNode as ChoiceNode, augSchema.childNodes);
779 * Utility method which search for original node defined in grouping.
\r
781 private def DataSchemaNode findOriginal(DataSchemaNode node) {
782 var DataSchemaNode result = findCorrectTargetFromGrouping(node);
783 if (result == null) {
784 result = findCorrectTargetFromAugment(node);
785 if (result != null) {
786 if (result.addedByUses) {
787 result = findOriginal(result);
794 private def DataSchemaNode findCorrectTargetFromAugment(DataSchemaNode node) {
795 if (!node.augmenting) {
799 var String currentName = node.QName.localName;
800 var tmpPath = new ArrayList<String>();
801 var YangNode parent = node;
802 var AugmentationSchema augment = null;
804 parent = (parent as DataSchemaNode).parent;
805 if (parent instanceof AugmentationTarget) {
806 tmpPath.add(currentName);
807 augment = findNodeInAugment((parent as AugmentationTarget).availableAugmentations, currentName);
808 if (augment == null) {
809 currentName = (parent as DataSchemaNode).QName.localName;
812 } while ((parent as DataSchemaNode).augmenting && augment == null);
814 if (augment == null) {
817 Collections.reverse(tmpPath);
818 var Object actualParent = augment;
819 var DataSchemaNode result = null;
820 for (name : tmpPath) {
821 if (actualParent instanceof DataNodeContainer) {
822 result = (actualParent as DataNodeContainer).getDataChildByName(name);
823 actualParent = (actualParent as DataNodeContainer).getDataChildByName(name);
825 if (actualParent instanceof ChoiceNode) {
826 result = (actualParent as ChoiceNode).getCaseNodeByName(name);
827 actualParent = (actualParent as ChoiceNode).getCaseNodeByName(name);
832 if (result.addedByUses) {
833 result = findCorrectTargetFromGrouping(result);
840 private def AugmentationSchema findNodeInAugment(Collection<AugmentationSchema> augments, String name) {
841 for (augment : augments) {
842 if (augment.getDataChildByName(name) != null) {
849 private def DataSchemaNode findCorrectTargetFromGrouping(DataSchemaNode node) {
850 if (node.path.path.size == 1) {
852 // uses is under module statement
\r
853 val Module m = findParentModule(schemaContext, node);
854 var DataSchemaNode result = null;
856 var SchemaNode targetGrouping = findNodeInSchemaContext(schemaContext, u.groupingPath.path);
857 if (!(targetGrouping instanceof GroupingDefinition)) {
858 throw new IllegalArgumentException("Failed to generate code for augment in " + u);
860 var gr = targetGrouping as GroupingDefinition;
861 result = gr.getDataChildByName(node.QName.localName);
863 if (result == null) {
864 throw new IllegalArgumentException("Failed to generate code for augment");
868 var DataSchemaNode result = null;
869 var String currentName = node.QName.localName;
870 var tmpPath = new ArrayList<String>();
871 var YangNode parent = node.parent;
873 tmpPath.add(currentName);
874 val dataNodeParent = parent as DataNodeContainer;
875 for (u : dataNodeParent.uses) {
876 if (result == null) {
\r
877 var SchemaNode targetGrouping = findNodeInSchemaContext(schemaContext, u.groupingPath.path);
878 if (!(targetGrouping instanceof GroupingDefinition)) {
879 throw new IllegalArgumentException("Failed to generate code for augment in " + u);
881 var gr = targetGrouping as GroupingDefinition;
882 result = gr.getDataChildByName(currentName);
\r
885 if (result == null) {
886 currentName = (parent as SchemaNode).QName.localName;
887 if (parent instanceof DataSchemaNode) {
888 parent = (parent as DataSchemaNode).parent;
890 parent = (parent as DataNodeContainer).parent;
893 } while (result == null && !(parent instanceof Module));
895 if (result != null) {
896 if (tmpPath.size == 1) {
\r
897 if (result != null && result.addedByUses) {
\r
898 result = findOriginal(result);
\r
902 var DataSchemaNode newParent = result;
903 Collections.reverse(tmpPath);
905 for (name : tmpPath) {
906 newParent = (newParent as DataNodeContainer).getDataChildByName(name);
908 if (newParent != null && newParent.addedByUses) {
\r
909 newParent = findOriginal(newParent);
\r
920 * Convenient method to find node added by uses statement.
\r
922 private def DataSchemaNode findOriginalTargetFromGrouping(String targetSchemaNodeName, UsesNode parentUsesNode) {
923 var SchemaNode targetGrouping = findNodeInSchemaContext(schemaContext, parentUsesNode.groupingPath.path);
924 if (!(targetGrouping instanceof GroupingDefinition)) {
925 throw new IllegalArgumentException("Failed to generate code for augment in " + parentUsesNode);
928 var grouping = targetGrouping as GroupingDefinition;
929 var result = grouping.getDataChildByName(targetSchemaNodeName);
930 if (result == null) {
933 var boolean fromUses = result.addedByUses;
935 var Iterator<UsesNode> groupingUses = grouping.uses.iterator;
937 if (groupingUses.hasNext()) {
938 grouping = findNodeInSchemaContext(schemaContext, groupingUses.next().groupingPath.path) as GroupingDefinition;
939 result = grouping.getDataChildByName(targetSchemaNodeName);
940 fromUses = result.addedByUses;
942 throw new NullPointerException("Failed to generate code for augment in " + parentUsesNode);
950 * Returns a generated type builder for an augmentation.
\r
952 * The name of the type builder is equal to the name of augmented node with
\r
953 * serial number as suffix.
\r
955 * @param module current module
\r
956 * @param augmentPackageName
\r
957 * string with contains the package name to which the augment
\r
959 * @param basePackageName
\r
960 * string with the package name to which the augmented node
\r
962 * @param targetTypeRef
\r
965 * augmentation schema which contains data about the child nodes
\r
966 * and uses of augment
\r
967 * @return generated type builder for augment
\r
969 private def GeneratedTypeBuilder addRawAugmentGenTypeDefinition(Module module, String augmentPackageName,
970 String basePackageName, Type targetTypeRef, AugmentationSchema augSchema) {
971 var Map<String, GeneratedTypeBuilder> augmentBuilders = genTypeBuilders.get(augmentPackageName);
972 if (augmentBuilders === null) {
973 augmentBuilders = new HashMap();
974 genTypeBuilders.put(augmentPackageName, augmentBuilders);
976 val augIdentifier = getAugmentIdentifier(augSchema.unknownSchemaNodes);
978 val augTypeName = if (augIdentifier !== null) {
979 BindingMapping.getClassName(augIdentifier)
981 augGenTypeName(augmentBuilders, targetTypeRef.name);
984 val augTypeBuilder = new GeneratedTypeBuilderImpl(augmentPackageName, augTypeName);
986 augTypeBuilder.addImplementsType(DATA_OBJECT);
987 augTypeBuilder.addImplementsType(Types.augmentationTypeFor(targetTypeRef));
988 addImplementedInterfaceFromUses(augSchema, augTypeBuilder);
990 augSchemaNodeToMethods(module, basePackageName, augTypeBuilder, augTypeBuilder, augSchema.childNodes);
991 augmentBuilders.put(augTypeName, augTypeBuilder);
992 return augTypeBuilder;
997 * @param unknownSchemaNodes
\r
998 * @return nodeParameter of UnknownSchemaNode
\r
1000 private def String getAugmentIdentifier(List<UnknownSchemaNode> unknownSchemaNodes) {
1001 for (unknownSchemaNode : unknownSchemaNodes) {
1002 val nodeType = unknownSchemaNode.nodeType;
1003 if (AUGMENT_IDENTIFIER_NAME.equals(nodeType.localName) &&
1004 YANG_EXT_NAMESPACE.equals(nodeType.namespace.toString())) {
1005 return unknownSchemaNode.nodeParameter;
1012 * Returns first unique name for the augment generated type builder. The
\r
1013 * generated type builder name for augment consists from name of augmented
\r
1014 * node and serial number of its augmentation.
\r
1017 * map of builders which were created in the package to which the
\r
1018 * augmentation belongs
\r
1019 * @param genTypeName
\r
1020 * string with name of augmented node
\r
1021 * @return string with unique name for augmentation builder
\r
1023 private def String augGenTypeName(Map<String, GeneratedTypeBuilder> builders, String genTypeName) {
1025 while ((builders !== null) && builders.containsKey(genTypeName + index)) {
1028 return genTypeName + index;
1032 * Adds the methods to <code>typeBuilder</code> which represent subnodes of
\r
1033 * node for which <code>typeBuilder</code> was created.
\r
1035 * The subnodes aren't mapped to the methods if they are part of grouping or
\r
1036 * augment (in this case are already part of them).
\r
1038 * @param module current module
\r
1039 * @param basePackageName
\r
1040 * string contains the module package name
\r
1042 * generated type builder which represents any node. The subnodes
\r
1043 * of this node are added to the <code>typeBuilder</code> as
\r
1044 * methods. The subnode can be of type leaf, leaf-list, list,
\r
1045 * container, choice.
\r
1046 * @param childOf parent type
\r
1047 * @param schemaNodes
\r
1048 * set of data schema nodes which are the children of the node
\r
1049 * for which <code>typeBuilder</code> was created
\r
1050 * @return generated type builder which is the same builder as input
\r
1051 * parameter. The getter methods (representing child nodes) could be
\r
1054 private def GeneratedTypeBuilder resolveDataSchemaNodes(Module module, String basePackageName,
1055 GeneratedTypeBuilder parent, GeneratedTypeBuilder childOf, Set<DataSchemaNode> schemaNodes) {
1056 if ((schemaNodes !== null) && (parent !== null)) {
1057 for (schemaNode : schemaNodes) {
1058 if (!schemaNode.augmenting && !schemaNode.addedByUses) {
1059 addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, parent, childOf, module);
1067 * Adds the methods to <code>typeBuilder</code> what represents subnodes of
\r
1068 * node for which <code>typeBuilder</code> was created.
\r
1070 * @param module current module
\r
1071 * @param basePackageName
\r
1072 * string contains the module package name
\r
1073 * @param typeBuilder
\r
1074 * generated type builder which represents any node. The subnodes
\r
1075 * of this node are added to the <code>typeBuilder</code> as
\r
1076 * methods. The subnode can be of type leaf, leaf-list, list,
\r
1077 * container, choice.
\r
1078 * @param childOf parent type
\r
1079 * @param schemaNodes
\r
1080 * set of data schema nodes which are the children of the node
\r
1081 * for which <code>typeBuilder</code> was created
\r
1082 * @return generated type builder which is the same object as the input
\r
1083 * parameter <code>typeBuilder</code>. The getter method could be
\r
1086 private def GeneratedTypeBuilder augSchemaNodeToMethods(Module module, String basePackageName,
1087 GeneratedTypeBuilder typeBuilder, GeneratedTypeBuilder childOf, Set<DataSchemaNode> schemaNodes) {
1088 if ((schemaNodes !== null) && (typeBuilder !== null)) {
1089 for (schemaNode : schemaNodes) {
1090 if (!schemaNode.isAugmenting()) {
1091 addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder, childOf, module);
1099 * Adds to <code>typeBuilder</code> a method which is derived from
\r
1100 * <code>schemaNode</code>.
\r
1102 * @param basePackageName
\r
1103 * string with the module package name
\r
1105 * data schema node which is added to <code>typeBuilder</code> as
\r
1107 * @param typeBuilder
\r
1108 * generated type builder to which is <code>schemaNode</code>
\r
1109 * added as a method.
\r
1110 * @param childOf parent type
\r
1111 * @param module current module
\r
1113 private def void addSchemaNodeToBuilderAsMethod(String basePackageName, DataSchemaNode node,
1114 GeneratedTypeBuilder typeBuilder, GeneratedTypeBuilder childOf, Module module) {
1115 if (node !== null && typeBuilder !== null) {
1117 case node instanceof LeafSchemaNode:
1118 resolveLeafSchemaNodeAsMethod(typeBuilder, node as LeafSchemaNode)
1119 case node instanceof LeafListSchemaNode:
1120 resolveLeafListSchemaNode(typeBuilder, node as LeafListSchemaNode)
1121 case node instanceof ContainerSchemaNode:
1122 containerToGenType(module, basePackageName, typeBuilder, childOf, node as ContainerSchemaNode)
1123 case node instanceof ListSchemaNode:
1124 listToGenType(module, basePackageName, typeBuilder, childOf, node as ListSchemaNode)
1125 case node instanceof ChoiceNode:
1126 choiceToGeneratedType(module, basePackageName, typeBuilder, node as ChoiceNode)
1132 * Converts <code>choiceNode</code> to the list of generated types for
\r
1133 * choice and its cases.
\r
1135 * The package names for choice and for its cases are created as
\r
1136 * concatenation of the module package (<code>basePackageName</code>) and
\r
1137 * names of all parents node.
\r
1139 * @param module current module
\r
1140 * @param basePackageName
\r
1141 * string with the module package name
\r
1142 * @param parent parent type
\r
1143 * @param childOf concrete parent for case child nodes
\r
1144 * @param choiceNode
\r
1145 * choice node which is mapped to generated type. Also child
\r
1146 * nodes - cases are mapped to generated types.
\r
1147 * @throws IllegalArgumentException
\r
1149 * <li>if <code>basePackageName</code> equals null</li>
\r
1150 * <li>if <code>choiceNode</code> equals null</li>
\r
1154 private def void choiceToGeneratedType(Module module, String basePackageName, GeneratedTypeBuilder parent,
1155 ChoiceNode choiceNode) {
1156 checkArgument(basePackageName !== null, "Base Package Name cannot be NULL.");
1157 checkArgument(choiceNode !== null, "Choice Schema Node cannot be NULL.");
1159 if (!choiceNode.addedByUses) {
1160 val packageName = packageNameForGeneratedType(basePackageName, choiceNode.path);
1161 val choiceTypeBuilder = addRawInterfaceDefinition(packageName, choiceNode);
1162 constructGetter(parent, choiceNode.QName.localName, choiceNode.description, choiceTypeBuilder);
1163 choiceTypeBuilder.addImplementsType(DataContainer.typeForClass);
1164 genCtx.get(module).addChildNodeType(choiceNode.path, choiceTypeBuilder)
1165 generateTypesFromChoiceCases(module, basePackageName, parent, choiceTypeBuilder.toInstance, choiceNode);
1170 * Converts <code>caseNodes</code> set to list of corresponding generated
\r
1173 * For every <i>case</i> which isn't added through augment or <i>uses</i> is
\r
1174 * created generated type builder. The package names for the builder is
\r
1175 * created as concatenation of the module package (
\r
1176 * <code>basePackageName</code>) and names of all parents nodes of the
\r
1177 * concrete <i>case</i>. There is also relation "<i>implements type</i>"
\r
1178 * between every case builder and <i>choice</i> type
\r
1180 * @param basePackageName
\r
1181 * string with the module package name
\r
1182 * @param refChoiceType
\r
1183 * type which represents superior <i>case</i>
\r
1184 * @param caseNodes
\r
1185 * set of choice case nodes which are mapped to generated types
\r
1186 * @return list of generated types for <code>caseNodes</code>.
\r
1187 * @throws IllegalArgumentException
\r
1189 * <li>if <code>basePackageName</code> equals null</li>
\r
1190 * <li>if <code>refChoiceType</code> equals null</li>
\r
1191 * <li>if <code>caseNodes</code> equals null</li>
\r
1195 private def void generateTypesFromChoiceCases(Module module, String basePackageName,
1196 GeneratedTypeBuilder choiceParent, Type refChoiceType, ChoiceNode choiceNode) {
1197 checkArgument(basePackageName !== null, "Base Package Name cannot be NULL.");
1198 checkArgument(refChoiceType !== null, "Referenced Choice Type cannot be NULL.");
1199 checkArgument(choiceNode !== null, "ChoiceNode cannot be NULL.");
1201 val Set<ChoiceCaseNode> caseNodes = choiceNode.cases;
1202 if (caseNodes == null) {
1206 for (caseNode : caseNodes) {
1207 if (caseNode !== null && !caseNode.isAddedByUses() && !caseNode.isAugmenting()) {
1208 val packageName = packageNameForGeneratedType(basePackageName, caseNode.path)
1209 val caseTypeBuilder = addDefaultInterfaceDefinition(packageName, caseNode)
1210 caseTypeBuilder.addImplementsType(refChoiceType)
1211 genCtx.get(module).addCaseType(caseNode.path, caseTypeBuilder)
1212 val Set<DataSchemaNode> caseChildNodes = caseNode.childNodes
1213 if (caseChildNodes !== null) {
1214 val parentNode = choiceNode.parent
1215 var SchemaNode parent
1216 if (parentNode instanceof AugmentationSchema) {
1217 val augSchema = parentNode as AugmentationSchema;
1218 val targetPath = augSchema.targetPath;
1219 var targetSchemaNode = findDataSchemaNode(schemaContext, targetPath)
1220 if (targetSchemaNode instanceof DataSchemaNode &&
1221 (targetSchemaNode as DataSchemaNode).isAddedByUses()) {
1222 targetSchemaNode = findOriginal(targetSchemaNode as DataSchemaNode);
1223 if (targetSchemaNode == null) {
1224 throw new NullPointerException(
1225 "Failed to find target node from grouping for augmentation " + augSchema +
1226 " in module " + module.name);
1229 parent = targetSchemaNode
1231 parent = choiceNode.parent as SchemaNode
1233 var GeneratedTypeBuilder childOfType = findChildNodeByPath(parent.path)
1234 resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, childOfType, caseChildNodes)
1238 processUsesAugments(caseNode, module);
1243 * Generates list of generated types for all the cases of a choice which are
\r
1244 * added to the choice through the augment.
\r
1247 * @param basePackageName
\r
1248 * string contains name of package to which augment belongs. If
\r
1249 * an augmented choice is from an other package (pcg1) than an
\r
1250 * augmenting choice (pcg2) then case's of the augmenting choice
\r
1251 * will belong to pcg2.
\r
1252 * @param refChoiceType
\r
1253 * Type which represents the choice to which case belongs. Every
\r
1254 * case has to contain its choice in extend part.
\r
1255 * @param caseNodes
\r
1256 * set of choice case nodes for which is checked if are/aren't
\r
1257 * added to choice through augmentation
\r
1258 * @return list of generated types which represents augmented cases of
\r
1259 * choice <code>refChoiceType</code>
\r
1260 * @throws IllegalArgumentException
\r
1262 * <li>if <code>basePackageName</code> equals null</li>
\r
1263 * <li>if <code>refChoiceType</code> equals null</li>
\r
1264 * <li>if <code>caseNodes</code> equals null</li>
\r
1267 private def void generateTypesFromAugmentedChoiceCases(Module module, String basePackageName, Type targetType,
1268 ChoiceNode targetNode, Set<DataSchemaNode> augmentedNodes) {
1269 checkArgument(basePackageName !== null, "Base Package Name cannot be NULL.");
1270 checkArgument(targetType !== null, "Referenced Choice Type cannot be NULL.");
1271 checkArgument(augmentedNodes !== null, "Set of Choice Case Nodes cannot be NULL.");
1273 for (caseNode : augmentedNodes) {
1274 if (caseNode !== null) {
1275 val packageName = packageNameForGeneratedType(basePackageName, caseNode.path);
1276 val caseTypeBuilder = addDefaultInterfaceDefinition(packageName, caseNode);
1277 caseTypeBuilder.addImplementsType(targetType);
1279 val SchemaNode parent = targetNode.parent as SchemaNode;
1280 var GeneratedTypeBuilder childOfType = null;
1281 if (parent instanceof Module) {
1282 childOfType = genCtx.get(parent as Module).moduleNode
1283 } else if (parent instanceof ChoiceCaseNode) {
1284 childOfType = findCaseByPath(parent.path)
1285 } else if (parent instanceof DataSchemaNode || parent instanceof NotificationDefinition) {
1286 childOfType = findChildNodeByPath(parent.path)
1287 } else if (parent instanceof GroupingDefinition) {
1288 childOfType = findGroupingByPath(parent.path);
1291 if (childOfType == null) {
1292 throw new IllegalArgumentException("Failed to find parent type of choice " + targetNode);
1295 if (caseNode instanceof DataNodeContainer) {
1296 val DataNodeContainer dataNodeCase = caseNode as DataNodeContainer;
1297 val Set<DataSchemaNode> childNodes = dataNodeCase.childNodes;
1298 if (childNodes !== null) {
1299 resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, childOfType, childNodes);
1302 val ChoiceCaseNode node = targetNode.getCaseNodeByName(caseNode.getQName().getLocalName());
1303 val Set<DataSchemaNode> childNodes = node.childNodes;
1304 if (childNodes !== null) {
1305 resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, childOfType, childNodes);
1309 genCtx.get(module).addCaseType(caseNode.path, caseTypeBuilder)
1316 * Converts <code>leaf</code> to the getter method which is added to
\r
1317 * <code>typeBuilder</code>.
\r
1319 * @param typeBuilder
\r
1320 * generated type builder to which is added getter method as
\r
1321 * <code>leaf</code> mapping
\r
1323 * leaf schema node which is mapped as getter method which is
\r
1324 * added to <code>typeBuilder</code>
\r
1325 * @return boolean value
\r
1327 * <li>false - if <code>leaf</code> or <code>typeBuilder</code> are
\r
1329 * <li>true - in other cases</li>
\r
1332 private def boolean resolveLeafSchemaNodeAsMethod(GeneratedTypeBuilder typeBuilder, LeafSchemaNode leaf) {
1333 if ((leaf !== null) && (typeBuilder !== null)) {
1334 val leafName = leaf.QName.localName;
1335 var String leafDesc = leaf.description;
1336 if (leafDesc === null) {
1340 val parentModule = findParentModule(schemaContext, leaf);
1341 if (leafName !== null && !leaf.isAddedByUses()) {
1342 val TypeDefinition<?> typeDef = leaf.type;
1344 var Type returnType = null;
1345 if (typeDef instanceof EnumTypeDefinition) {
1346 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
1347 val enumTypeDef = typeDef as EnumTypeDefinition;
1348 val enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, leaf.QName, typeBuilder);
1350 if (enumBuilder !== null) {
1351 returnType = new ReferencedTypeImpl(enumBuilder.packageName, enumBuilder.name);
1353 (typeProvider as TypeProviderImpl).putReferencedType(leaf.path, returnType);
1354 } else if (typeDef instanceof UnionType) {
1355 val genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule);
1356 if (genTOBuilder !== null) {
1357 returnType = new ReferencedTypeImpl(genTOBuilder.packageName, genTOBuilder.name);
1359 } else if (typeDef instanceof BitsTypeDefinition) {
1360 val genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule);
1361 if (genTOBuilder !== null) {
1362 returnType = new ReferencedTypeImpl(genTOBuilder.packageName, genTOBuilder.name);
1365 val Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
\r
1366 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, restrictions);
1368 if (returnType !== null) {
1369 val MethodSignatureBuilder getter = constructGetter(typeBuilder, leafName, leafDesc, returnType);
1370 processContextRefExtension(leaf, getter, parentModule);
1378 private def void processContextRefExtension(LeafSchemaNode leaf, MethodSignatureBuilder getter, Module module) {
1379 for (node : leaf.unknownSchemaNodes) {
1380 val nodeType = node.nodeType;
1381 if ("context-reference".equals(nodeType.localName)) {
1382 val nodeParam = node.nodeParameter;
1383 var IdentitySchemaNode identity = null;
1384 var String basePackageName = null;
1385 val String[] splittedElement = nodeParam.split(":");
1386 if (splittedElement.length == 1) {
1387 identity = findIdentityByName(module.identities, splittedElement.get(0));
1388 basePackageName = moduleNamespaceToPackageName(module);
1389 } else if (splittedElement.length == 2) {
1390 var prefix = splittedElement.get(0);
1391 val Module dependentModule = findModuleFromImports(module.imports, prefix)
1392 if (dependentModule == null) {
1393 throw new IllegalArgumentException(
1394 "Failed to process context-reference: unknown prefix " + prefix);
1396 identity = findIdentityByName(dependentModule.identities, splittedElement.get(1));
1397 basePackageName = moduleNamespaceToPackageName(dependentModule);
1399 throw new IllegalArgumentException(
1400 "Failed to process context-reference: unknown identity " + nodeParam);
1402 if (identity == null) {
1403 throw new IllegalArgumentException(
1404 "Failed to process context-reference: unknown identity " + nodeParam);
1407 val Class<RoutingContext> clazz = typeof(RoutingContext);
1408 val AnnotationTypeBuilder rc = getter.addAnnotation(clazz.package.name, clazz.simpleName);
1409 val packageName = packageNameForGeneratedType(basePackageName, identity.path);
1410 val genTypeName = BindingMapping.getClassName(identity.QName.localName);
1411 rc.addParameter("value", packageName + "." + genTypeName + ".class");
1416 private def IdentitySchemaNode findIdentityByName(Set<IdentitySchemaNode> identities, String name) {
1417 for (id : identities) {
1418 if (id.QName.localName.equals(name)) {
1425 private def Module findModuleFromImports(Set<ModuleImport> imports, String prefix) {
1426 for (imp : imports) {
1427 if (imp.prefix.equals(prefix)) {
1428 return schemaContext.findModuleByName(imp.moduleName, imp.revision);
1435 * Converts <code>leaf</code> schema node to property of generated TO
\r
1438 * @param toBuilder
\r
1439 * generated TO builder to which is <code>leaf</code> added as
\r
1442 * leaf schema node which is added to <code>toBuilder</code> as
\r
1444 * @param isReadOnly
\r
1445 * boolean value which says if leaf property is|isn't read only
\r
1446 * @return boolean value
\r
1448 * <li>false - if <code>leaf</code>, <code>toBuilder</code> or leaf
\r
1449 * name equals null or if leaf is added by <i>uses</i>.</li>
\r
1450 * <li>true - other cases</li>
\r
1453 private def boolean resolveLeafSchemaNodeAsProperty(GeneratedTOBuilder toBuilder, LeafSchemaNode leaf,
1454 boolean isReadOnly) {
1455 if ((leaf !== null) && (toBuilder !== null)) {
1456 val leafName = leaf.QName.localName;
1457 var String leafDesc = leaf.description;
1458 if (leafDesc === null) {
1462 if (leafName !== null) {
1463 val TypeDefinition<?> typeDef = leaf.type;
1465 // TODO: properly resolve enum types
\r
1466 val returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
1467 if (returnType !== null) {
1468 val propBuilder = toBuilder.addProperty(parseToValidParamName(leafName));
1469 propBuilder.setReadOnly(isReadOnly);
1470 propBuilder.setReturnType(returnType);
1471 propBuilder.setComment(leafDesc);
1472 toBuilder.addEqualsIdentity(propBuilder);
1473 toBuilder.addHashIdentity(propBuilder);
1474 toBuilder.addToStringProperty(propBuilder);
1483 * Converts <code>node</code> leaf list schema node to getter method of
\r
1484 * <code>typeBuilder</code>.
\r
1486 * @param typeBuilder
\r
1487 * generated type builder to which is <code>node</code> added as
\r
1490 * leaf list schema node which is added to
\r
1491 * <code>typeBuilder</code> as getter method
\r
1492 * @return boolean value
\r
1494 * <li>true - if <code>node</code>, <code>typeBuilder</code>,
\r
1495 * nodeName equal null or <code>node</code> is added by <i>uses</i></li>
\r
1496 * <li>false - other cases</li>
\r
1499 private def boolean resolveLeafListSchemaNode(GeneratedTypeBuilder typeBuilder, LeafListSchemaNode node) {
1500 if ((node !== null) && (typeBuilder !== null)) {
1501 val nodeName = node.QName;
1502 var String nodeDesc = node.description;
1503 if (nodeDesc === null) {
1506 if (nodeName !== null && !node.isAddedByUses()) {
1507 val TypeDefinition<?> typeDef = node.type;
\r
1508 val parentModule = findParentModule(schemaContext, node);
\r
1510 var Type returnType = null;
\r
1511 if (typeDef instanceof EnumTypeDefinition) {
\r
1512 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node);
\r
1513 val enumTypeDef = typeDef as EnumTypeDefinition;
\r
1514 val enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, nodeName, typeBuilder);
\r
1515 returnType = new ReferencedTypeImpl(enumBuilder.packageName, enumBuilder.name);
\r
1516 (typeProvider as TypeProviderImpl).putReferencedType(node.path, returnType);
\r
1517 } else if (typeDef instanceof UnionType) {
\r
1518 val genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule);
\r
1519 returnType = new ReferencedTypeImpl(genTOBuilder.packageName, genTOBuilder.name);
\r
1520 } else if (typeDef instanceof BitsTypeDefinition) {
\r
1521 val genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule);
\r
1522 returnType = new ReferencedTypeImpl(genTOBuilder.packageName, genTOBuilder.name);
\r
1524 val Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
\r
1525 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, restrictions);
\r
1528 val listType = Types.listTypeFor(returnType);
1529 constructGetter(typeBuilder, nodeName.localName, nodeDesc, listType);
1536 private def GeneratedTypeBuilder addDefaultInterfaceDefinition(String packageName, SchemaNode schemaNode) {
1537 return addDefaultInterfaceDefinition(packageName, schemaNode, null);
1541 * Instantiates generated type builder with <code>packageName</code> and
\r
1542 * <code>schemaNode</code>.
\r
1544 * The new builder always implements
\r
1545 * {@link org.opendaylight.yangtools.yang.binding.DataObject DataObject}.<br />
\r
1546 * If <code>schemaNode</code> is instance of GroupingDefinition it also
\r
1547 * implements {@link org.opendaylight.yangtools.yang.binding.Augmentable
\r
1548 * Augmentable}.<br />
\r
1549 * If <code>schemaNode</code> is instance of
\r
1550 * {@link org.opendaylight.yangtools.yang.model.api.DataNodeContainer
\r
1551 * DataNodeContainer} it can also implement nodes which are specified in
\r
1554 * @param packageName
\r
1555 * string with the name of the package to which
\r
1556 * <code>schemaNode</code> belongs.
\r
1557 * @param schemaNode
\r
1558 * schema node for which is created generated type builder
\r
1559 * @param parent parent type (can be null)
\r
1560 * @return generated type builder <code>schemaNode</code>
\r
1562 private def GeneratedTypeBuilder addDefaultInterfaceDefinition(String packageName, SchemaNode schemaNode,
1564 val it = addRawInterfaceDefinition(packageName, schemaNode, "");
\r
1565 val qname = schemaNode.QName;
1566 qnameConstant(BindingMapping.QNAME_STATIC_FIELD_NAME,schemaNode.QName);
\r
1567 if (parent === null) {
1568 addImplementsType(DATA_OBJECT);
1570 addImplementsType(BindingTypes.childOf(parent));
1572 if (!(schemaNode instanceof GroupingDefinition)) {
1573 addImplementsType(augmentable(it));
1576 if (schemaNode instanceof DataNodeContainer) {
1577 addImplementedInterfaceFromUses(schemaNode as DataNodeContainer, it);
1584 * Wraps the calling of the same overloaded method.
\r
1586 * @param packageName
\r
1587 * string with the package name to which returning generated type
\r
1589 * @param schemaNode
\r
1590 * schema node which provide data about the schema node name
\r
1591 * @return generated type builder for <code>schemaNode</code>
\r
1593 private def GeneratedTypeBuilder addRawInterfaceDefinition(String packageName, SchemaNode schemaNode) {
1594 return addRawInterfaceDefinition(packageName, schemaNode, "");
1598 * Returns reference to generated type builder for specified
\r
1599 * <code>schemaNode</code> with <code>packageName</code>.
\r
1601 * Firstly the generated type builder is searched in
\r
1602 * {@link BindingGeneratorImpl#genTypeBuilders genTypeBuilders}. If it isn't
\r
1603 * found it is created and added to <code>genTypeBuilders</code>.
\r
1605 * @param packageName
\r
1606 * string with the package name to which returning generated type
\r
1608 * @param schemaNode
\r
1609 * schema node which provide data about the schema node name
\r
1610 * @param prefix return type name prefix
\r
1611 * @return generated type builder for <code>schemaNode</code>
\r
1612 * @throws IllegalArgumentException
\r
1614 * <li>if <code>schemaNode</code> equals null</li>
\r
1615 * <li>if <code>packageName</code> equals null</li>
\r
1616 * <li>if Q name of schema node is null</li>
\r
1617 * <li>if schema node name is nul</li>
\r
1621 private def GeneratedTypeBuilder addRawInterfaceDefinition(String packageName, SchemaNode schemaNode,
1623 checkArgument(schemaNode !== null, "Data Schema Node cannot be NULL.");
1624 checkArgument(packageName !== null, "Package Name for Generated Type cannot be NULL.");
1625 checkArgument(schemaNode.QName !== null, "QName for Data Schema Node cannot be NULL.");
1626 val schemaNodeName = schemaNode.QName.localName;
1627 checkArgument(schemaNodeName !== null, "Local Name of QName for Data Schema Node cannot be NULL.");
1629 var String genTypeName;
1630 if (prefix === null) {
1631 genTypeName = BindingMapping.getClassName(schemaNodeName);
1633 genTypeName = prefix + BindingMapping.getClassName(schemaNodeName);
1636 //FIXME: Validation of name conflict
\r
1637 val newType = new GeneratedTypeBuilderImpl(packageName, genTypeName);
1638 if (!genTypeBuilders.containsKey(packageName)) {
1639 val Map<String, GeneratedTypeBuilder> builders = new HashMap();
1640 builders.put(genTypeName, newType);
1641 genTypeBuilders.put(packageName, builders);
1643 val Map<String, GeneratedTypeBuilder> builders = genTypeBuilders.get(packageName);
1644 if (!builders.containsKey(genTypeName)) {
1645 builders.put(genTypeName, newType);
1652 * Creates the name of the getter method from <code>methodName</code>.
\r
1654 * @param methodName
\r
1655 * string with the name of the getter method
\r
1656 * @param returnType return type
\r
1657 * @return string with the name of the getter method for
\r
1658 * <code>methodName</code> in JAVA method format
\r
1660 public static def String getterMethodName(String localName, Type returnType) {
1661 val method = new StringBuilder();
1662 if (BOOLEAN.equals(returnType)) {
1663 method.append("is");
1665 method.append("get");
1667 method.append(BindingMapping.getClassName(localName));
1668 return method.toString();
1672 * Created a method signature builder as part of
\r
1673 * <code>interfaceBuilder</code>.
\r
1675 * The method signature builder is created for the getter method of
\r
1676 * <code>schemaNodeName</code>. Also <code>comment</code> and
\r
1677 * <code>returnType</code> information are added to the builder.
\r
1679 * @param interfaceBuilder
\r
1680 * generated type builder for which the getter method should be
\r
1682 * @param schemaNodeName
\r
1683 * string with schema node name. The name will be the part of the
\r
1684 * getter method name.
\r
1686 * string with comment for the getter method
\r
1687 * @param returnType
\r
1688 * type which represents the return type of the getter method
\r
1689 * @return method signature builder which represents the getter method of
\r
1690 * <code>interfaceBuilder</code>
\r
1692 private def MethodSignatureBuilder constructGetter(GeneratedTypeBuilder interfaceBuilder, String schemaNodeName,
1693 String comment, Type returnType) {
1694 val getMethod = interfaceBuilder.addMethod(getterMethodName(schemaNodeName, returnType));
1695 getMethod.setComment(comment);
1696 getMethod.setReturnType(returnType);
1701 * Adds <code>schemaNode</code> to <code>typeBuilder</code> as getter method
\r
1702 * or to <code>genTOBuilder</code> as property.
\r
1704 * @param basePackageName
\r
1705 * string contains the module package name
\r
1706 * @param schemaNode
\r
1707 * data schema node which should be added as getter method to
\r
1708 * <code>typeBuilder</code> or as a property to
\r
1709 * <code>genTOBuilder</code> if is part of the list key
\r
1710 * @param typeBuilder
\r
1711 * generated type builder for the list schema node
\r
1712 * @param genTOBuilder
\r
1713 * generated TO builder for the list keys
\r
1715 * list of string which contains names of the list keys
\r
1716 * @param module current module
\r
1717 * @throws IllegalArgumentException
\r
1719 * <li>if <code>schemaNode</code> equals null</li>
\r
1720 * <li>if <code>typeBuilder</code> equals null</li>
\r
1723 private def void addSchemaNodeToListBuilders(String basePackageName, DataSchemaNode schemaNode,
1724 GeneratedTypeBuilder typeBuilder, GeneratedTOBuilder genTOBuilder, List<String> listKeys, Module module) {
1725 checkArgument(schemaNode !== null, "Data Schema Node cannot be NULL.");
1726 checkArgument(typeBuilder !== null, "Generated Type Builder cannot be NULL.");
1728 if (schemaNode instanceof LeafSchemaNode) {
1729 val leaf = schemaNode as LeafSchemaNode;
1730 val leafName = leaf.QName.localName;
\r
1731 resolveLeafSchemaNodeAsMethod(typeBuilder, leaf);
1732 if (listKeys.contains(leafName)) {
1733 resolveLeafSchemaNodeAsProperty(genTOBuilder, leaf, true);
1735 } else if (!schemaNode.addedByUses) {
1736 if (schemaNode instanceof LeafListSchemaNode) {
1737 resolveLeafListSchemaNode(typeBuilder, schemaNode as LeafListSchemaNode);
1738 } else if (schemaNode instanceof ContainerSchemaNode) {
1739 containerToGenType(module, basePackageName, typeBuilder, typeBuilder, schemaNode as ContainerSchemaNode);
1740 } else if (schemaNode instanceof ChoiceNode) {
1741 choiceToGeneratedType(module, basePackageName, typeBuilder, schemaNode as ChoiceNode);
1742 } else if (schemaNode instanceof ListSchemaNode) {
1743 listToGenType(module, basePackageName, typeBuilder, typeBuilder, schemaNode as ListSchemaNode);
1748 private def typeBuildersToGenTypes(Module module, GeneratedTypeBuilder typeBuilder, GeneratedTOBuilder genTOBuilder) {
1749 checkArgument(typeBuilder !== null, "Generated Type Builder cannot be NULL.");
1751 if (genTOBuilder !== null) {
1752 val genTO = genTOBuilder.toInstance();
1753 constructGetter(typeBuilder, "key", "Returns Primary Key of Yang List Type", genTO);
1754 genCtx.get(module).addGeneratedTOBuilder(genTOBuilder)
1759 * Selects the names of the list keys from <code>list</code> and returns
\r
1760 * them as the list of the strings
\r
1763 * of string with names of the list keys
\r
1764 * @return list of string which represents names of the list keys. If the
\r
1765 * <code>list</code> contains no keys then the empty list is
\r
1768 private def listKeys(ListSchemaNode list) {
1769 val List<String> listKeys = new ArrayList();
1771 if (list.keyDefinition !== null) {
1772 val keyDefinitions = list.keyDefinition;
1773 for (keyDefinition : keyDefinitions) {
1774 listKeys.add(keyDefinition.localName);
1781 * Generates for the <code>list</code> which contains any list keys special
\r
1782 * generated TO builder.
\r
1784 * @param packageName
\r
1785 * string with package name to which the list belongs
\r
1787 * list schema node which is source of data about the list name
\r
1788 * @return generated TO builder which represents the keys of the
\r
1789 * <code>list</code> or null if <code>list</code> is null or list of
\r
1790 * key definitions is null or empty.
\r
1792 private def GeneratedTOBuilder resolveListKeyTOBuilder(String packageName, ListSchemaNode list) {
1793 var GeneratedTOBuilder genTOBuilder = null;
1794 if ((list.keyDefinition !== null) && (!list.keyDefinition.isEmpty())) {
1795 val listName = list.QName.localName + "Key";
1796 val String genTOName = BindingMapping.getClassName(listName);
1797 genTOBuilder = new GeneratedTOBuilderImpl(packageName, genTOName);
1799 return genTOBuilder;
1803 * Builds generated TO builders for <code>typeDef</code> of type
\r
1804 * {@link org.opendaylight.yangtools.yang.model.util.UnionType UnionType} or
\r
1805 * {@link org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition
\r
1806 * BitsTypeDefinition} which are also added to <code>typeBuilder</code> as
\r
1807 * enclosing transfer object.
\r
1809 * If more then one generated TO builder is created for enclosing then all
\r
1810 * of the generated TO builders are added to <code>typeBuilder</code> as
\r
1811 * enclosing transfer objects.
\r
1814 * type definition which can be of type <code>UnionType</code> or
\r
1815 * <code>BitsTypeDefinition</code>
\r
1816 * @param typeBuilder
\r
1817 * generated type builder to which is added generated TO created
\r
1818 * from <code>typeDef</code>
\r
1820 * string with name for generated TO builder
\r
1822 * @param parentModule
\r
1823 * @return generated TO builder for <code>typeDef</code>
\r
1825 private def GeneratedTOBuilder addTOToTypeBuilder(TypeDefinition<?> typeDef, GeneratedTypeBuilder typeBuilder,
1826 DataSchemaNode leaf, Module parentModule) {
1827 val classNameFromLeaf = BindingMapping.getClassName(leaf.QName);
1828 val List<GeneratedTOBuilder> genTOBuilders = new ArrayList();
1829 val packageName = typeBuilder.fullyQualifiedName;
1830 if (typeDef instanceof UnionTypeDefinition) {
1831 genTOBuilders.addAll(
1832 (typeProvider as TypeProviderImpl).
1833 provideGeneratedTOBuildersForUnionTypeDef(packageName, (typeDef as UnionTypeDefinition),
1834 classNameFromLeaf, leaf));
1835 } else if (typeDef instanceof BitsTypeDefinition) {
1837 ((typeProvider as TypeProviderImpl) ).
1838 provideGeneratedTOBuilderForBitsTypeDefinition(packageName, typeDef, classNameFromLeaf));
1840 if (genTOBuilders !== null && !genTOBuilders.isEmpty()) {
1841 for (genTOBuilder : genTOBuilders) {
1842 typeBuilder.addEnclosingTransferObject(genTOBuilder);
1844 return genTOBuilders.get(0);
1851 * Adds the implemented types to type builder.
\r
1853 * The method passes through the list of <i>uses</i> in
\r
1854 * {@code dataNodeContainer}. For every <i>use</i> is obtained coresponding
\r
1855 * generated type from {@link BindingGeneratorImpl#allGroupings
\r
1856 * allGroupings} which is added as <i>implements type</i> to
\r
1857 * <code>builder</code>
\r
1859 * @param dataNodeContainer
\r
1860 * element which contains the list of used YANG groupings
\r
1862 * builder to which are added implemented types according to
\r
1863 * <code>dataNodeContainer</code>
\r
1864 * @return generated type builder with all implemented types
\r
1866 private def addImplementedInterfaceFromUses(DataNodeContainer dataNodeContainer, GeneratedTypeBuilder builder) {
1867 for (usesNode : dataNodeContainer.uses) {
1868 if (usesNode.groupingPath !== null) {
1869 val genType = findGroupingByPath(usesNode.groupingPath).toInstance
1870 if (genType === null) {
1871 throw new IllegalStateException(
1872 "Grouping " + usesNode.groupingPath + "is not resolved for " + builder.name);
1874 builder.addImplementsType(genType);
1880 private def GeneratedTypeBuilder findChildNodeByPath(SchemaPath path) {
1881 for (ctx : genCtx.values) {
1882 var result = ctx.getChildNode(path)
1883 if (result !== null) {
1890 private def GeneratedTypeBuilder findGroupingByPath(SchemaPath path) {
1891 for (ctx : genCtx.values) {
1892 var result = ctx.getGrouping(path)
1893 if (result !== null) {
1900 private def GeneratedTypeBuilder findCaseByPath(SchemaPath path) {
1901 for (ctx : genCtx.values) {
1902 var result = ctx.getCase(path)
1903 if (result !== null) {
1911 public def getModuleContexts() {
\r