Merge "Added initial draft of Normalized Yang Data Tree model."
[yangtools.git] / code-generator / binding-generator-impl / src / main / java / org / opendaylight / yangtools / sal / binding / generator / impl / BindingGeneratorImpl.xtend
1 /*\r
2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.\r
3  *\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
7  */
8 package org.opendaylight.yangtools.sal.binding.generator.impl;
9 \r
10 import static com.google.common.base.Preconditions.*;\r
11 import static extension org.opendaylight.yangtools.binding.generator.util.Types.*;\r
12 import static org.opendaylight.yangtools.binding.generator.util.BindingGeneratorUtil.*;\r
13 import static org.opendaylight.yangtools.binding.generator.util.BindingTypes.*;\r
14 import static org.opendaylight.yangtools.yang.model.util.SchemaContextUtil.*;\r
15
16 import java.util.ArrayList;
17 import java.util.Collections;
18 import java.util.HashMap;
19 import java.util.List;
20 import java.util.Map;
21 import java.util.Set;\r
22 import java.util.Iterator\r
23 import java.util.Collection
24 import org.opendaylight.yangtools.binding.generator.util.BindingTypes;
25 import org.opendaylight.yangtools.binding.generator.util.ReferencedTypeImpl;
26 import org.opendaylight.yangtools.binding.generator.util.Types;
27 import org.opendaylight.yangtools.binding.generator.util.generated.type.builder.GeneratedTOBuilderImpl;
28 import org.opendaylight.yangtools.binding.generator.util.generated.type.builder.GeneratedTypeBuilderImpl;
29 import org.opendaylight.yangtools.sal.binding.generator.api.BindingGenerator;
30 import org.opendaylight.yangtools.sal.binding.generator.spi.TypeProvider;
31 import org.opendaylight.yangtools.sal.binding.model.api.AccessModifier;
32 import org.opendaylight.yangtools.sal.binding.model.api.Type;
33 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.EnumBuilder;
34 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedTOBuilder;
35 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedTypeBuilder;
36 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.MethodSignatureBuilder;
37 import org.opendaylight.yangtools.sal.binding.yang.types.GroupingDefinitionDependencySort;
38 import org.opendaylight.yangtools.sal.binding.yang.types.TypeProviderImpl;
39 import org.opendaylight.yangtools.yang.binding.RpcService;
40 import org.opendaylight.yangtools.yang.common.RpcResult;
41 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
42 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
43 import org.opendaylight.yangtools.yang.model.api.ChoiceNode;
44 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
45 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
46 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
47 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
48 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
49 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
50 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
51 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
52 import org.opendaylight.yangtools.yang.model.api.Module;
53 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
54 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
55 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
56 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
57 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
58 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
59 import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition;
60 import org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition;
61 import org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition;
62 import org.opendaylight.yangtools.yang.model.util.DataNodeIterator;
63 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
64 import org.opendaylight.yangtools.yang.model.util.UnionType;
65 import org.opendaylight.yangtools.yang.parser.util.ModuleDependencySort
66 import org.opendaylight.yangtools.yang.model.util.ExtendedType;
67 import org.opendaylight.yangtools.yang.model.api.UsesNode
68 import org.opendaylight.yangtools.yang.binding.annotations.RoutingContext
69 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.AnnotationTypeBuilder
70 import org.opendaylight.yangtools.yang.model.api.ModuleImport
71 import org.opendaylight.yangtools.yang.binding.DataContainer
72 import org.opendaylight.yangtools.yang.model.api.AugmentationTarget
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
80
81 import com.google.common.collect.Sets
82 import java.net.URI
83 import java.util.Date
84
85 public class BindingGeneratorImpl implements BindingGenerator {
86
87     private final Map<Module, ModuleContext> genCtx = new HashMap()
88
89     /**\r
90      * Outer key represents the package name. Outer value represents map of\r
91      * all builders in the same package. Inner key represents the schema node\r
92      * name (in JAVA class/interface name format). Inner value represents\r
93      * instance of builder for schema node specified in key part.\r
94      */
95     private Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders;
96
97     /**\r
98      * Provide methods for converting YANG types to JAVA types.\r
99      */
100     private var TypeProvider typeProvider;
101
102     /**\r
103      * Holds reference to schema context to resolve data of augmented element\r
104      * when creating augmentation builder\r
105      */
106     private var SchemaContext schemaContext;
107
108     /**\r
109      * Constant with the concrete name of namespace.\r
110      */
111     private val static String YANG_EXT_NAMESPACE = "urn:opendaylight:yang:extension:yang-ext";
112
113     /**\r
114      * Constant with the concrete name of identifier.\r
115      */
116     private val static String AUGMENT_IDENTIFIER_NAME = "augment-identifier";
117
118     /**\r
119      * Resolves generated types from <code>context</code> schema nodes of all\r
120      * modules.\r
121      *\r
122      * Generated types are created for modules, groupings, types, containers,\r
123      * lists, choices, augments, rpcs, notification, identities.\r
124      *\r
125      * @param context\r
126      *            schema context which contains data about all schema nodes\r
127      *            saved in modules\r
128      * @return list of types (usually <code>GeneratedType</code>\r
129      *         <code>GeneratedTransferObject</code>which are generated from\r
130      *         <code>context</code> data.\r
131      * @throws IllegalArgumentException\r
132      *             if param <code>context</code> is null\r
133      * @throws IllegalStateException\r
134      *             if <code>context</code> contain no modules\r
135      */
136     override generateTypes(SchemaContext context) {
137         checkArgument(context !== null, "Schema Context reference cannot be NULL.");
138         checkState(context.modules !== null, "Schema Context does not contain defined modules.");
139         schemaContext = context;
140         typeProvider = new TypeProviderImpl(context);
141         val Set<Module> modules = context.modules;
142         return generateTypes(context, modules);
143     }
144
145     /**\r
146      * Resolves generated types from <code>context</code> schema nodes only for\r
147      * modules specified in <code>modules</code>\r
148      *\r
149      * Generated types are created for modules, groupings, types, containers,\r
150      * lists, choices, augments, rpcs, notification, identities.\r
151      *\r
152      * @param context\r
153      *            schema context which contains data about all schema nodes\r
154      *            saved in modules\r
155      * @param modules\r
156      *            set of modules for which schema nodes should be generated\r
157      *            types\r
158      * @return list of types (usually <code>GeneratedType</code> or\r
159      *         <code>GeneratedTransferObject</code>) which:\r
160      *         <ul>\r
161      *         <li>are generated from <code>context</code> schema nodes and</li>\r
162      *         <li>are also part of some of the module in <code>modules</code>\r
163      *         set</li>.\r
164      *         </ul>\r
165      * @throws IllegalArgumentException\r
166      *             <ul>\r
167      *             <li>if param <code>context</code> is null or</li>\r
168      *             <li>if param <code>modules</code> is null</li>\r
169      *             </ul>\r
170      * @throws IllegalStateException\r
171      *             if <code>context</code> contain no modules\r
172      */
173     override generateTypes(SchemaContext context, Set<Module> modules) {
174         checkArgument(context !== null, "Schema Context reference cannot be NULL.");
175         checkState(context.modules !== null, "Schema Context does not contain defined modules.");
176         checkArgument(modules !== null, "Set of Modules cannot be NULL.");
177
178         schemaContext = context;
179         typeProvider = new TypeProviderImpl(context);
180         val contextModules = ModuleDependencySort.sort(context.modules);
181         genTypeBuilders = new HashMap();
182
183         for (contextModule : contextModules) {
184             moduleToGenTypes(contextModule, context);
185         }
186         for (contextModule : contextModules) {
187             allAugmentsToGenTypes(contextModule);
188         }
189
190         val List<Type> filteredGenTypes = new ArrayList();
191         for (Module m : modules) {
192             filteredGenTypes.addAll(genCtx.get(m).generatedTypes);\r
193             val Set<Type> additionalTypes = (typeProvider as TypeProviderImpl).additionalTypes.get(m)\r
194             if (additionalTypes != null) {\r
195                 filteredGenTypes.addAll(additionalTypes)\r
196             }
197         }\r
198
199         return filteredGenTypes;
200     }
201
202     private def void moduleToGenTypes(Module m, SchemaContext context) {
203         genCtx.put(m, new ModuleContext)
204         allTypeDefinitionsToGenTypes(m)
205         groupingsToGenTypes(m, m.groupings)
206         rpcMethodsToGenType(m)
207         allIdentitiesToGenTypes(m, context)
208         notificationsToGenType(m)
209
210         if (!m.childNodes.isEmpty()) {
211             val moduleType = moduleToDataType(m)
212             genCtx.get(m).addModuleNode(moduleType)
213             val basePackageName = moduleNamespaceToPackageName(m);
214             resolveDataSchemaNodes(m, basePackageName, moduleType, moduleType, m.childNodes)
215         }
216     }
217
218     /**\r
219      * Converts all extended type definitions of module to the list of\r
220      * <code>Type</code> objects.\r
221      *\r
222      * @param module\r
223      *            module from which is obtained set of type definitions\r
224      * @throws IllegalArgumentException\r
225      *             <ul>\r
226      *             <li>if module equals null</li>\r
227      *             <li>if name of module equals null</li>\r
228      *             <li>if type definitions of module equal null</li>\r
229      *             </ul>\r
230      *\r
231      */
232     private def void allTypeDefinitionsToGenTypes(Module module) {
233         checkArgument(module !== null, "Module reference cannot be NULL.");
234         checkArgument(module.name !== null, "Module name cannot be NULL.");
235         val it = new DataNodeIterator(module);
236         val List<TypeDefinition<?>> typeDefinitions = it.allTypedefs;
237         checkState(typeDefinitions !== null, '''Type Definitions for module Â«module.name» cannot be NULL.''');
238
239         for (TypeDefinition<?> typedef : typeDefinitions) {
240             if (typedef !== null) {
241                 val type = (typeProvider as TypeProviderImpl).generatedTypeForExtendedDefinitionType(typedef, typedef);
242                 if (type !== null) {
243                     genCtx.get(module).addTypedefType(typedef.path, type)
244                 }
245             }
246         }
247     }\r
248 \r
249     private def GeneratedTypeBuilder processDataSchemaNode(Module module, String basePackageName,
250         GeneratedTypeBuilder parent, GeneratedTypeBuilder childOf, DataSchemaNode node) {
251         if (node.augmenting || node.addedByUses) {
252             return null
253         }
254         val packageName = packageNameForGeneratedType(basePackageName, node.path)
255         val genType = addDefaultInterfaceDefinition(packageName, node, childOf)
256         if (node instanceof DataNodeContainer) {
257             genCtx.get(module).addChildNodeType(node.path, genType)
258             groupingsToGenTypes(module, (node as DataNodeContainer).groupings)
259             processUsesAugments(node as DataNodeContainer, module)
260         }
261         return genType
262     }
263
264     private def void containerToGenType(Module module, String basePackageName, GeneratedTypeBuilder parent,
265         GeneratedTypeBuilder childOf, ContainerSchemaNode node) {
266         val genType = processDataSchemaNode(module, basePackageName, parent, childOf, node)
267         if (genType != null) {
268             constructGetter(parent, node.QName.localName, node.description, genType)
269             resolveDataSchemaNodes(module, basePackageName, genType, genType, node.childNodes)
270         }
271     }
272
273     private def void listToGenType(Module module, String basePackageName, GeneratedTypeBuilder parent,
274         GeneratedTypeBuilder childOf, ListSchemaNode node) {
275         val genType = processDataSchemaNode(module, basePackageName, parent, childOf, node)
276         if (genType != null) {
277             constructGetter(parent, node.QName.localName, node.description, Types.listTypeFor(genType))
278
279             val List<String> listKeys = listKeys(node);
280             val packageName = packageNameForGeneratedType(basePackageName, (node).path)
281             val genTOBuilder = resolveListKeyTOBuilder(packageName, node);
282             if (genTOBuilder !== null) {
283                 val identifierMarker = IDENTIFIER.parameterizedTypeFor(genType);
284                 val identifiableMarker = IDENTIFIABLE.parameterizedTypeFor(genTOBuilder);
285                 genTOBuilder.addImplementsType(identifierMarker);
286                 genType.addImplementsType(identifiableMarker);
287             }
288
289             for (schemaNode : node.childNodes) {
290                 if (!schemaNode.augmenting) {
291                     addSchemaNodeToListBuilders(basePackageName, schemaNode, genType, genTOBuilder, listKeys, module);
292                 }
293             }
294
295             // serialVersionUID\r
296             if (genTOBuilder !== null) {
297                 val GeneratedPropertyBuilder prop = new GeneratedPropertyBuilderImpl("serialVersionUID");
298                 prop.setValue(Long.toString(computeDefaultSUID(genTOBuilder as GeneratedTOBuilderImpl)));
299                 genTOBuilder.setSUID(prop);
300             }
301
302             typeBuildersToGenTypes(module, genType, genTOBuilder);
303         }
304     }
305
306     private def void processUsesAugments(DataNodeContainer node, Module module) {
307         val basePackageName = moduleNamespaceToPackageName(module);
308         for (usesNode : node.uses) {
309             for (augment : usesNode.augmentations) {
310                 usesAugmentationToGenTypes(basePackageName, augment, module, usesNode, node);
311                 processUsesAugments(augment, module);
312             }
313         }
314     }
315
316     /**\r
317      * Converts all <b>augmentation</b> of the module to the list\r
318      * <code>Type</code> objects.\r
319      *\r
320      * @param module\r
321      *            module from which is obtained list of all augmentation objects\r
322      *            to iterate over them\r
323      * @throws IllegalArgumentException\r
324      *             <ul>\r
325      *             <li>if the module equals null</li>\r
326      *             <li>if the name of module equals null</li>\r
327      *             <li>if the set of child nodes equals null</li>\r
328      *             </ul>\r
329      *\r
330      */
331     private def void allAugmentsToGenTypes(Module module) {
332         checkArgument(module !== null, "Module reference cannot be NULL.");
333         checkArgument(module.name !== null, "Module name cannot be NULL.");
334         if (module.childNodes === null) {
335             throw new IllegalArgumentException(
336                 "Reference to Set of Augmentation Definitions in module " + module.name + " cannot be NULL.");
337         }
338
339         val basePackageName = moduleNamespaceToPackageName(module);
340         val List<AugmentationSchema> augmentations = resolveAugmentations(module);
341         for (augment : augmentations) {
342             augmentationToGenTypes(basePackageName, augment, module);
343         }
344     }
345
346     /**\r
347      * Returns list of <code>AugmentationSchema</code> objects. The objects are\r
348      * sorted according to the length of their target path from the shortest to\r
349      * the longest.\r
350      *\r
351      * @param module\r
352      *            module from which is obtained list of all augmentation objects\r
353      * @return list of sorted <code>AugmentationSchema</code> objects obtained\r
354      *         from <code>module</code>\r
355      * @throws IllegalArgumentException\r
356      *             <ul>\r
357      *             <li>if the module equals null</li>\r
358      *             <li>if the set of augmentation equals null</li>\r
359      *             </ul>\r
360      *\r
361      */
362     private def List<AugmentationSchema> resolveAugmentations(Module module) {
363         checkArgument(module !== null, "Module reference cannot be NULL.");
364         checkState(module.augmentations !== null, "Augmentations Set cannot be NULL.");
365
366         val Set<AugmentationSchema> augmentations = module.augmentations;
367         val List<AugmentationSchema> sortedAugmentations = new ArrayList(augmentations);
368         Collections.sort(sortedAugmentations,
369             [ augSchema1, augSchema2 |
370                 if (augSchema1.targetPath.path.size() > augSchema2.targetPath.path.size()) {
371                     return 1;
372                 } else if (augSchema1.targetPath.path.size() < augSchema2.targetPath.path.size()) {
373                     return -1;
374                 }
375                 return 0;
376             ]);
377         return sortedAugmentations;
378     }
379
380     /**\r
381      * Converts whole <b>module</b> to <code>GeneratedType</code> object.\r
382      * Firstly is created the module builder object from which is vally\r
383      * obtained reference to <code>GeneratedType</code> object.\r
384      *\r
385      * @param module\r
386      *            module from which are obtained the module name, child nodes,\r
387      *            uses and is derived package name\r
388      * @return <code>GeneratedType</code> which is internal representation of\r
389      *         the module\r
390      * @throws IllegalArgumentException\r
391      *             if the module equals null\r
392      *\r
393      */
394     private def GeneratedTypeBuilder moduleToDataType(Module module) {
395         checkArgument(module !== null, "Module reference cannot be NULL.");
396
397         val moduleDataTypeBuilder = moduleTypeBuilder(module, "Data");
398         addImplementedInterfaceFromUses(module, moduleDataTypeBuilder);
399         moduleDataTypeBuilder.addImplementsType(DATA_ROOT);
400         return moduleDataTypeBuilder;
401     }
402
403     /**\r
404      * Converts all <b>rpcs</b> inputs and outputs substatements of the module\r
405      * to the list of <code>Type</code> objects. In addition are to containers\r
406      * and lists which belong to input or output also part of returning list.\r
407      *\r
408      * @param module\r
409      *            module from which is obtained set of all rpc objects to\r
410      *            iterate over them\r
411      * @throws IllegalArgumentException\r
412      *             <ul>\r
413      *             <li>if the module equals null</li>\r
414      *             <li>if the name of module equals null</li>\r
415      *             <li>if the set of child nodes equals null</li>\r
416      *             </ul>\r
417      *\r
418      */
419     private def void rpcMethodsToGenType(Module module) {
420         checkArgument(module !== null, "Module reference cannot be NULL.");
421         checkArgument(module.name !== null, "Module name cannot be NULL.");
422         checkArgument(module.childNodes !== null,
423             "Reference to Set of RPC Method Definitions in module " + module.name + " cannot be NULL.");
424
425         val basePackageName = moduleNamespaceToPackageName(module);
426         val Set<RpcDefinition> rpcDefinitions = module.rpcs;
427         if (rpcDefinitions.isEmpty()) {
428             return;
429         }
430
431         val interfaceBuilder = moduleTypeBuilder(module, "Service");
432         interfaceBuilder.addImplementsType(Types.typeForClass(RpcService));
433         for (rpc : rpcDefinitions) {
434             if (rpc !== null) {
435                 val rpcName = BindingMapping.getClassName(rpc.QName);
436                 val rpcMethodName = parseToValidParamName(rpcName);
437                 val method = interfaceBuilder.addMethod(rpcMethodName);
438                 val input = rpc.input;
439                 val output = rpc.output;
440
441                 if (input !== null) {
442                     val inType = addRawInterfaceDefinition(basePackageName, input, rpcName);
443                     addImplementedInterfaceFromUses(input, inType);
444                     inType.addImplementsType(DATA_OBJECT);
445                     inType.addImplementsType(augmentable(inType));
446                     resolveDataSchemaNodes(module, basePackageName, inType, inType, input.childNodes);
447                     genCtx.get(module).addChildNodeType(input.path, inType)
448                     val inTypeInstance = inType.toInstance();
449                     method.addParameter(inTypeInstance, "input");
450                 }
451
452                 var Type outTypeInstance = VOID;
453                 if (output !== null) {
454                     val outType = addRawInterfaceDefinition(basePackageName, output, rpcName);
455                     addImplementedInterfaceFromUses(output, outType);
456                     outType.addImplementsType(DATA_OBJECT);
457                     outType.addImplementsType(augmentable(outType));
458                     resolveDataSchemaNodes(module, basePackageName, outType, outType, output.childNodes);
459                     genCtx.get(module).addChildNodeType(output.path, outType)
460                     outTypeInstance = outType.toInstance();
461                 }
462
463                 val rpcRes = Types.parameterizedTypeFor(Types.typeForClass(RpcResult), outTypeInstance);
464                 method.setReturnType(Types.parameterizedTypeFor(FUTURE, rpcRes));
465             }
466         }
467
468         genCtx.get(module).addTopLevelNodeType(interfaceBuilder)
469     }
470
471     /**\r
472      * Converts all <b>notifications</b> of the module to the list of\r
473      * <code>Type</code> objects. In addition are to this list added containers\r
474      * and lists which are part of this notification.\r
475      *\r
476      * @param module\r
477      *            module from which is obtained set of all notification objects\r
478      *            to iterate over them\r
479      * @throws IllegalArgumentException\r
480      *             <ul>\r
481      *             <li>if the module equals null</li>\r
482      *             <li>if the name of module equals null</li>\r
483      *             <li>if the set of child nodes equals null</li>\r
484      *             </ul>\r
485      *\r
486      */
487     private def void notificationsToGenType(Module module) {
488         checkArgument(module !== null, "Module reference cannot be NULL.");
489         checkArgument(module.name !== null, "Module name cannot be NULL.");
490
491         if (module.childNodes === null) {
492             throw new IllegalArgumentException(
493                 "Reference to Set of Notification Definitions in module " + module.name + " cannot be NULL.");
494         }
495         val notifications = module.notifications;
496         if(notifications.empty) return;
497
498         val listenerInterface = moduleTypeBuilder(module, "Listener");
499         listenerInterface.addImplementsType(BindingTypes.NOTIFICATION_LISTENER);
500         val basePackageName = moduleNamespaceToPackageName(module);
501
502         for (notification : notifications) {
503             if (notification !== null) {
504                 processUsesAugments(notification, module);
505
506                 val notificationInterface = addDefaultInterfaceDefinition(basePackageName, notification,
507                     BindingTypes.DATA_OBJECT);
508                 notificationInterface.addImplementsType(NOTIFICATION);
509                 genCtx.get(module).addChildNodeType(notification.path, notificationInterface)
510
511                 // Notification object\r
512                 resolveDataSchemaNodes(module, basePackageName, notificationInterface, notificationInterface,
513                     notification.childNodes);
514
515                 listenerInterface.addMethod("on" + notificationInterface.name) //\r
516                 .setAccessModifier(AccessModifier.PUBLIC).addParameter(notificationInterface, "notification").
517                     setReturnType(Types.VOID);
518             }
519         }
520
521         genCtx.get(module).addTopLevelNodeType(listenerInterface)
522     }
523
524     /**\r
525      * Converts all <b>identities</b> of the module to the list of\r
526      * <code>Type</code> objects.\r
527      *\r
528      * @param module\r
529      *            module from which is obtained set of all identity objects to\r
530      *            iterate over them\r
531      * @param context\r
532      *            schema context only used as input parameter for method\r
533      *            {@link identityToGenType}\r
534      *\r
535      */
536     private def void allIdentitiesToGenTypes(Module module, SchemaContext context) {
537         val Set<IdentitySchemaNode> schemaIdentities = module.identities;
538         val basePackageName = moduleNamespaceToPackageName(module);
539
540         if (schemaIdentities !== null && !schemaIdentities.isEmpty()) {
541             for (identity : schemaIdentities) {
542                 identityToGenType(module, basePackageName, identity, context);
543             }
544         }
545     }
546
547     /**\r
548      * Converts the <b>identity</b> object to GeneratedType. Firstly it is\r
549      * created transport object builder. If identity contains base identity then\r
550      * reference to base identity is added to superior identity as its extend.\r
551      * If identity doesn't contain base identity then only reference to abstract\r
552      * class {@link org.opendaylight.yangtools.yang.model.api.BaseIdentity\r
553      * BaseIdentity} is added\r
554      *\r
555      * @param module current module\r
556      * @param basePackageName\r
557      *            string contains the module package name\r
558      * @param identity\r
559      *            IdentitySchemaNode which contains data about identity\r
560      * @param context\r
561      *            SchemaContext which is used to get package and name\r
562      *            information about base of identity\r
563      *\r
564      */
565     private def void identityToGenType(Module module, String basePackageName, IdentitySchemaNode identity,
566         SchemaContext context) {
567         if (identity === null) {
568             return;
569         }
570         val packageName = packageNameForGeneratedType(basePackageName, identity.path);
571         val genTypeName = BindingMapping.getClassName(identity.QName);
572         val newType = new GeneratedTOBuilderImpl(packageName, genTypeName);
573         val baseIdentity = identity.baseIdentity;
574         if (baseIdentity === null) {
575             newType.setExtendsType(Types.baseIdentityTO);
576         } else {
577             val baseIdentityParentModule = SchemaContextUtil.findParentModule(context, baseIdentity);
578             val returnTypePkgName = moduleNamespaceToPackageName(baseIdentityParentModule);
579             val returnTypeName = BindingMapping.getClassName(baseIdentity.QName);
580             val gto = new GeneratedTOBuilderImpl(returnTypePkgName, returnTypeName).toInstance();
581             newType.setExtendsType(gto);
582         }
583         newType.setAbstract(true);\r
584         val qname = identity.QName;\r
585         \r
586         newType.qnameConstant(BindingMapping.QNAME_STATIC_FIELD_NAME,qname);\r
587         
588         genCtx.get(module).addIdentityType(identity.QName,newType)
589     }\r
590     \r
591     private static def qnameConstant(GeneratedTypeBuilderBase<?> toBuilder, String constantName, QName name) {
592         toBuilder.addConstant(QName.typeForClass,constantName,'''\r
593             org.opendaylight.yangtools.yang.common.QName.create("«name.namespace»","«name.formattedRevision»","«name.localName»")\r
594         ''');
595     }
596
597     /**\r
598      * Converts all <b>groupings</b> of the module to the list of\r
599      * <code>Type</code> objects. Firstly are groupings sorted according mutual\r
600      * dependencies. At least dependent (independent) groupings are in the list\r
601      * saved at first positions. For every grouping the record is added to map\r
602      * {@link BindingGeneratorImpl#allGroupings allGroupings}\r
603      *\r
604      * @param module\r
605      *            current module\r
606      * @param collection of groupings from which types will be generated\r
607      *\r
608      */
609     private def void groupingsToGenTypes(Module module, Collection<GroupingDefinition> groupings) {
610         val basePackageName = moduleNamespaceToPackageName(module);
611         val List<GroupingDefinition> groupingsSortedByDependencies = new GroupingDefinitionDependencySort().sort(
612             groupings);
613         for (grouping : groupingsSortedByDependencies) {
614             groupingToGenType(basePackageName, grouping, module);
615         }
616     }
617
618     /**\r
619      * Converts individual grouping to GeneratedType. Firstly generated type\r
620      * builder is created and every child node of grouping is resolved to the\r
621      * method.\r
622      *\r
623      * @param basePackageName\r
624      *            string contains the module package name\r
625      * @param grouping\r
626      *            GroupingDefinition which contains data about grouping\r
627      * @param module current module\r
628      * @return GeneratedType which is generated from grouping (object of type\r
629      *         <code>GroupingDefinition</code>)\r
630      */
631     private def void groupingToGenType(String basePackageName, GroupingDefinition grouping, Module module) {
632         val packageName = packageNameForGeneratedType(basePackageName, grouping.path);
633         val genType = addDefaultInterfaceDefinition(packageName, grouping);
634         genCtx.get(module).addGroupingType(grouping.path, genType)
635         resolveDataSchemaNodes(module, basePackageName, genType, genType, grouping.childNodes);
636         groupingsToGenTypes(module, grouping.groupings);
637         processUsesAugments(grouping, module);
638     }
639
640     /**\r
641      * Tries to find EnumTypeDefinition in <code>typeDefinition</code>. If base\r
642      * type of <code>typeDefinition</code> is of the type ExtendedType then this\r
643      * method is recursively called with this base type.\r
644      *\r
645      * @param typeDefinition\r
646      *            TypeDefinition in which should be EnumTypeDefinition found as\r
647      *            base type\r
648      * @return EnumTypeDefinition if it is found inside\r
649      *         <code>typeDefinition</code> or <code>null</code> in other case\r
650      */
651     private def EnumTypeDefinition enumTypeDefFromExtendedType(TypeDefinition<?> typeDefinition) {
652         if (typeDefinition !== null) {
653             if (typeDefinition.baseType instanceof EnumTypeDefinition) {
654                 return typeDefinition.baseType as EnumTypeDefinition;
655             } else if (typeDefinition.baseType instanceof ExtendedType) {
656                 return enumTypeDefFromExtendedType(typeDefinition.baseType);
657             }
658         }
659         return null;
660     }
661
662     /**\r
663      * Adds enumeration builder created from <code>enumTypeDef</code> to\r
664      * <code>typeBuilder</code>.\r
665      *\r
666      * Each <code>enumTypeDef</code> item is added to builder with its name and\r
667      * value.\r
668      *\r
669      * @param enumTypeDef\r
670      *            EnumTypeDefinition contains enum data\r
671      * @param enumName\r
672      *            string contains name which will be assigned to enumeration\r
673      *            builder\r
674      * @param typeBuilder\r
675      *            GeneratedTypeBuilder to which will be enum builder assigned\r
676      * @return enumeration builder which contains data from\r
677      *         <code>enumTypeDef</code>\r
678      */
679     private def EnumBuilder resolveInnerEnumFromTypeDefinition(EnumTypeDefinition enumTypeDef, QName enumName,
680         GeneratedTypeBuilder typeBuilder) {
681         if ((enumTypeDef !== null) && (typeBuilder !== null) && (enumTypeDef.QName !== null) &&
682             (enumTypeDef.QName.localName !== null)) {
683             val enumerationName = BindingMapping.getClassName(enumName);
684             val enumBuilder = typeBuilder.addEnumeration(enumerationName);
685             enumBuilder.updateEnumPairsFromEnumTypeDef(enumTypeDef);
686             return enumBuilder;
687         }
688         return null;
689     }
690
691     /**\r
692      * Generates type builder for <code>module</code>.\r
693      *\r
694      * @param module\r
695      *            Module which is source of package name for generated type\r
696      *            builder\r
697      * @param postfix\r
698      *            string which is added to the module class name representation\r
699      *            as suffix\r
700      * @return instance of GeneratedTypeBuilder which represents\r
701      *         <code>module</code>.\r
702      * @throws IllegalArgumentException\r
703      *             if <code>module</code> equals null\r
704      */
705     private def GeneratedTypeBuilder moduleTypeBuilder(Module module, String postfix) {
706         checkArgument(module !== null, "Module reference cannot be NULL.");
707         val packageName = moduleNamespaceToPackageName(module);
708         val moduleName = BindingMapping.getClassName(module.name) + postfix;
709         return new GeneratedTypeBuilderImpl(packageName, moduleName);
710     }
711
712     /**\r
713      * Converts <code>augSchema</code> to list of <code>Type</code> which\r
714      * contains generated type for augmentation. In addition there are also\r
715      * generated types for all containers, list and choices which are child of\r
716      * <code>augSchema</code> node or a generated types for cases are added if\r
717      * augmented node is choice.\r
718      *\r
719      * @param augmentPackageName\r
720      *            string with the name of the package to which the augmentation\r
721      *            belongs\r
722      * @param augSchema\r
723      *            AugmentationSchema which is contains data about augmentation\r
724      *            (target path, childs...)\r
725      * @param module current module\r
726      * @param parentUsesNode parent uses node of this augment (can be null if this augment is not defined under uses statement)\r
727      * @throws IllegalArgumentException\r
728      *             <ul>\r
729      *             <li>if <code>augmentPackageName</code> equals null</li>\r
730      *             <li>if <code>augSchema</code> equals null</li>\r
731      *             <li>if target path of <code>augSchema</code> equals null</li>\r
732      *             </ul>\r
733      */
734     private def void augmentationToGenTypes(String augmentPackageName, AugmentationSchema augSchema, Module module) {
735         checkArgument(augmentPackageName !== null, "Package Name cannot be NULL.");
736         checkArgument(augSchema !== null, "Augmentation Schema cannot be NULL.");
737         checkState(augSchema.targetPath !== null,
738             "Augmentation Schema does not contain Target Path (Target Path is NULL).");
739
740         processUsesAugments(augSchema, module);
741         val targetPath = augSchema.targetPath;
742         var SchemaNode targetSchemaNode = null
743
744         targetSchemaNode = findDataSchemaNode(schemaContext, targetPath);
745         if (targetSchemaNode instanceof DataSchemaNode && (targetSchemaNode as DataSchemaNode).isAddedByUses()) {
746             targetSchemaNode = findOriginal(targetSchemaNode as DataSchemaNode);
747             if (targetSchemaNode == null) {
748                 throw new NullPointerException(
749                     "Failed to find target node from grouping in augmentation " + augSchema + " in module " +
750                         module.name);
751             }
752         }
753         if (targetSchemaNode == null) {
754             throw new IllegalArgumentException("augment target not found: " + targetPath)
755         }
756
757         var targetTypeBuilder = findChildNodeByPath(targetSchemaNode.path)
758         if (targetTypeBuilder === null) {
759             targetTypeBuilder = findCaseByPath(targetSchemaNode.path)
760         }
761         if (targetTypeBuilder === null) {
762             throw new NullPointerException("Target type not yet generated: " + targetSchemaNode);
763         }\r
764
765         if (!(targetSchemaNode instanceof ChoiceNode)) {
766             var packageName = augmentPackageName;
767             val augTypeBuilder = addRawAugmentGenTypeDefinition(module, packageName, augmentPackageName,
768                 targetTypeBuilder.toInstance, augSchema);
769             genCtx.get(module).addAugmentType(augTypeBuilder)
770             genCtx.get(module).addTypeToAugmentation(augTypeBuilder, augSchema);
771         } else {
772             generateTypesFromAugmentedChoiceCases(module, augmentPackageName, targetTypeBuilder.toInstance,
773                 targetSchemaNode as ChoiceNode, augSchema.childNodes);
774         }
775     }
776 \r
777     private def void usesAugmentationToGenTypes(String augmentPackageName, AugmentationSchema augSchema, Module module,
778         UsesNode usesNode, DataNodeContainer usesNodeParent) {
779         checkArgument(augmentPackageName !== null, "Package Name cannot be NULL.");
780         checkArgument(augSchema !== null, "Augmentation Schema cannot be NULL.");
781         checkState(augSchema.targetPath !== null,
782             "Augmentation Schema does not contain Target Path (Target Path is NULL).");
783
784         processUsesAugments(augSchema, module);
785         val targetPath = augSchema.targetPath;
786         var SchemaNode targetSchemaNode = null
787         targetSchemaNode = findOriginalTargetFromGrouping(targetPath, usesNode);
788         if (targetSchemaNode == null) {
789             throw new IllegalArgumentException("augment target not found: " + targetPath)
790         }
791
792         var targetTypeBuilder = findChildNodeByPath(targetSchemaNode.path)
793         if (targetTypeBuilder === null) {
794             targetTypeBuilder = findCaseByPath(targetSchemaNode.path)
795         }
796         if (targetTypeBuilder === null) {
797             throw new NullPointerException("Target type not yet generated: " + targetSchemaNode);
798         }\r
799
800         if (!(targetSchemaNode instanceof ChoiceNode)) {
801             var packageName = augmentPackageName;
802             if (usesNodeParent instanceof SchemaNode) {
803                 packageName = packageNameForGeneratedType(augmentPackageName, (usesNodeParent as SchemaNode).path, true)
804             }
805             val augTypeBuilder = addRawAugmentGenTypeDefinition(module, packageName, augmentPackageName,
806                 targetTypeBuilder.toInstance, augSchema);
807             genCtx.get(module).addAugmentType(augTypeBuilder)
808             genCtx.get(module).addTypeToAugmentation(augTypeBuilder, augSchema);
809         } else {
810             generateTypesFromAugmentedChoiceCases(module, augmentPackageName, targetTypeBuilder.toInstance,
811                 targetSchemaNode as ChoiceNode, augSchema.childNodes);
812         }
813     }\r
814
815     /**\r
816      * Utility method which search for original node defined in grouping.\r
817      */
818     private def DataSchemaNode findOriginal(DataSchemaNode node) {
819         var DataSchemaNode result = findCorrectTargetFromGrouping(node);
820         if (result == null) {
821             result = findCorrectTargetFromAugment(node);
822             if (result != null) {
823                 if (result.addedByUses) {
824                     result = findOriginal(result);
825                 }
826             }
827         }
828         return result;
829     }
830
831     private def DataSchemaNode findCorrectTargetFromAugment(DataSchemaNode node) {
832         if (!node.augmenting) {
833             return null
834         }
835
836         var QName currentName = node.QName\r
837         var Object currentNode = node
838         var Object parent = node;\r
839         val tmpPath = new ArrayList<QName>()\r
840         val tmpTree = new ArrayList<SchemaNode>()\r
841
842         var AugmentationSchema augment = null;
843         do {\r
844             val SchemaPath sp = (parent as SchemaNode).path\r
845             val List<QName> names = sp.path\r
846             val List<QName> newNames = new ArrayList(names)\r
847             newNames.remove(newNames.size - 1)\r
848             val SchemaPath newSp = new SchemaPath(newNames, sp.absolute)\r
849             parent = findDataSchemaNode(schemaContext, newSp)\r
850             if (parent instanceof AugmentationTarget) {
851                 tmpPath.add(currentName);\r
852                 tmpTree.add(currentNode as SchemaNode)\r
853                 augment = findNodeInAugment((parent as AugmentationTarget).availableAugmentations, currentName);
854                 if (augment == null) {
855                     currentName = (parent as DataSchemaNode).QName\r
856                     currentNode = parent
857                 }
858             }
859         } while ((parent as DataSchemaNode).augmenting && augment == null);
860
861         if (augment == null) {
862             return null;
863         } else {
864             Collections.reverse(tmpPath);\r
865             Collections.reverse(tmpTree);
866             var Object actualParent = augment;
867             var DataSchemaNode result = null;
868             for (name : tmpPath) {
869                 if (actualParent instanceof DataNodeContainer) {
870                     result = (actualParent as DataNodeContainer).getDataChildByName(name.localName);
871                     actualParent = (actualParent as DataNodeContainer).getDataChildByName(name.localName);
872                 } else {
873                     if (actualParent instanceof ChoiceNode) {
874                         result = (actualParent as ChoiceNode).getCaseNodeByName(name.localName);
875                         actualParent = (actualParent as ChoiceNode).getCaseNodeByName(name.localName);
876                     }
877                 }
878             }
879
880             if (result.addedByUses) {\r
881                 result = findCorrectTargetFromAugmentGrouping(result, augment, tmpTree);
882             }
883
884             return result;
885         }
886     }
887
888     private def AugmentationSchema findNodeInAugment(Collection<AugmentationSchema> augments, QName name) {
889         for (augment : augments) {\r
890             val DataSchemaNode node = augment.getDataChildByName(name);\r
891             if (node != null) {
892                 return augment;
893             }
894         }
895         return null;
896     }
897 \r
898     private def DataSchemaNode findCorrectTargetFromGrouping(DataSchemaNode node) {\r
899         if (node.path.path.size == 1) {\r
900             // uses is under module statement\r
901             val Module m = findParentModule(schemaContext, node);\r
902             var DataSchemaNode result = null;\r
903             for (u : m.uses) {\r
904                 var SchemaNode targetGrouping = findNodeInSchemaContext(schemaContext, u.groupingPath.path);\r
905                 if (!(targetGrouping instanceof GroupingDefinition)) {\r
906                     throw new IllegalArgumentException("Failed to generate code for augment in " + u);\r
907                 }\r
908                 var gr = targetGrouping as GroupingDefinition;\r
909                 result = gr.getDataChildByName(node.QName.localName);\r
910             }\r
911             if (result == null) {\r
912                 throw new IllegalArgumentException("Failed to generate code for augment")\r
913             }\r
914             return result\r
915         } else {\r
916             var DataSchemaNode result = null;\r
917             var QName currentName = node.QName\r
918             var tmpPath = new ArrayList<QName>()\r
919             var Object parent = null\r
920
921             val SchemaPath sp = node.path
922             val List<QName> names = sp.path
923             val List<QName> newNames = new ArrayList(names)
924             newNames.remove(newNames.size - 1)
925             val SchemaPath newSp = new SchemaPath(newNames, sp.absolute)
926             parent = findDataSchemaNode(schemaContext, newSp)
927 \r
928             do {\r
929                 tmpPath.add(currentName);\r
930                 if (parent instanceof DataNodeContainer) {\r
931                     val dataNodeParent = parent as DataNodeContainer;\r
932                     for (u : dataNodeParent.uses) {\r
933                         if (result == null) {\r
934                             result = getResultFromUses(u, currentName.localName)\r
935                         }\r
936                     }\r
937                 }\r
938                 if (result == null) {
939                     currentName = (parent as SchemaNode).QName
940                     if (parent instanceof SchemaNode) {
941                         val SchemaPath nodeSp = (parent as SchemaNode).path
942                         val List<QName> nodeNames = nodeSp.path
943                         val List<QName> nodeNewNames = new ArrayList(nodeNames)
944                         nodeNewNames.remove(nodeNewNames.size - 1)
945                         if (nodeNewNames.empty) {
946                             parent = getParentModule(parent as SchemaNode)
947                         } else {
948                             val SchemaPath nodeNewSp = new SchemaPath(nodeNewNames, nodeSp.absolute)
949                             parent = findDataSchemaNode(schemaContext, nodeNewSp)
950                         }
951                     } else {
952                         throw new IllegalArgumentException("Failed to generate code for augment")
953                     }
954                 }\r
955             } while (result == null && !(parent instanceof Module));\r
956 \r
957             if (result != null) {\r
958                 result = getTargetNode(tmpPath, result)\r
959             }\r
960             return result;\r
961         }\r
962     }\r
963 \r
964     private def DataSchemaNode findCorrectTargetFromAugmentGrouping(DataSchemaNode node, AugmentationSchema parentNode,
965         List<SchemaNode> dataTree) {\r
966 \r
967         var DataSchemaNode result = null;
968         var QName currentName = node.QName
969         var tmpPath = new ArrayList<QName>()\r
970         tmpPath.add(currentName)\r
971         var int i = 1;\r
972         var Object parent = null
973 \r
974         do {\r
975             if (dataTree.size < 2 || dataTree.size == i) {
976                 parent = parentNode
977             } else {
978                 parent = dataTree.get(dataTree.size - (i+1))
979                 tmpPath.add((parent as SchemaNode).QName)
980             }\r
981
982             val dataNodeParent = parent as DataNodeContainer;
983             for (u : dataNodeParent.uses) {
984                 if (result == null) {\r
985                     result = getResultFromUses(u, currentName.localName)
986                 }
987             }
988             if (result == null) {
989                 i = i + 1\r
990                 currentName = (parent as SchemaNode).QName
991             }
992         } while (result == null);
993 \r
994         if (result != null) {
995             result = getTargetNode(tmpPath, result)\r
996         }
997         return result;
998     }\r
999 \r
1000     private def getResultFromUses(UsesNode u, String currentName) {
1001         var SchemaNode targetGrouping = findNodeInSchemaContext(schemaContext, u.groupingPath.path)
1002         if (!(targetGrouping instanceof GroupingDefinition)) {
1003             throw new IllegalArgumentException("Failed to generate code for augment in " + u)
1004         }
1005         var gr = targetGrouping as GroupingDefinition
1006         return gr.getDataChildByName(currentName)
1007     }\r
1008 \r
1009     private def getTargetNode(List<QName> tmpPath, DataSchemaNode node) {
1010         var DataSchemaNode result = node
1011         if (tmpPath.size == 1) {
1012             if (result != null && result.addedByUses) {
1013                 result = findOriginal(result);
1014             }
1015             return result;
1016         } else {
1017             var DataSchemaNode newParent = result;
1018             Collections.reverse(tmpPath);
1019
1020             tmpPath.remove(0);
1021             for (name : tmpPath) {\r
1022                 // searching by local name is must, because node has different namespace in its original location\r
1023                 if (newParent instanceof DataNodeContainer) {\r
1024                     newParent = (newParent as DataNodeContainer).getDataChildByName(name.localName);\r
1025                 } else {\r
1026                     newParent = (newParent as ChoiceNode).getCaseNodeByName(name.localName);\r
1027                 }
1028             }
1029             if (newParent != null && newParent.addedByUses) {
1030                 newParent = findOriginal(newParent);
1031             }
1032             return newParent;
1033         }
1034     }\r
1035
1036
1037     /**\r
1038      * Convenient method to find node added by uses statement.\r
1039      */
1040     private def DataSchemaNode findOriginalTargetFromGrouping(SchemaPath targetPath, UsesNode parentUsesNode) {
1041         var SchemaNode targetGrouping = findNodeInSchemaContext(schemaContext, parentUsesNode.groupingPath.path);
1042         if (!(targetGrouping instanceof GroupingDefinition)) {
1043             throw new IllegalArgumentException("Failed to generate code for augment in " + parentUsesNode);
1044         }
1045
1046         var grouping = targetGrouping as GroupingDefinition;\r
1047         var SchemaNode result = grouping;\r
1048         val List<QName> path = targetPath.path\r
1049         for (node : path) {
1050             // finding by local name is valid, grouping cannot contain nodes with same name and different namespace\r
1051             if (result instanceof DataNodeContainer) {
1052                 result = (result as DataNodeContainer).getDataChildByName(node.localName)
1053             } else if (result instanceof ChoiceNode) {
1054                 result = (result as ChoiceNode).getCaseNodeByName(node.localName)
1055             }
1056         }
1057         if (result == null) {
1058             return null;
1059         }\r
1060 \r
1061         val String targetSchemaNodeName = result.QName.localName;
1062         var boolean fromUses = (result as DataSchemaNode).addedByUses
1063         var Iterator<UsesNode> groupingUses = grouping.uses.iterator;
1064         while (fromUses) {
1065             if (groupingUses.hasNext()) {
1066                 grouping = findNodeInSchemaContext(schemaContext, groupingUses.next().groupingPath.path) as GroupingDefinition;
1067                 result = grouping.getDataChildByName(targetSchemaNodeName);
1068                 fromUses = (result as DataSchemaNode).addedByUses;
1069             } else {
1070                 throw new NullPointerException("Failed to generate code for augment in " + parentUsesNode);
1071             }
1072         }
1073
1074         return result as DataSchemaNode
1075     }
1076
1077     /**\r
1078      * Returns a generated type builder for an augmentation.\r
1079      *\r
1080      * The name of the type builder is equal to the name of augmented node with\r
1081      * serial number as suffix.\r
1082      *\r
1083      * @param module current module\r
1084      * @param augmentPackageName\r
1085      *            string with contains the package name to which the augment\r
1086      *            belongs\r
1087      * @param basePackageName\r
1088      *            string with the package name to which the augmented node\r
1089      *            belongs\r
1090      * @param targetTypeRef\r
1091      *            target type\r
1092      * @param augSchema\r
1093      *            augmentation schema which contains data about the child nodes\r
1094      *            and uses of augment\r
1095      * @return generated type builder for augment\r
1096      */
1097     private def GeneratedTypeBuilder addRawAugmentGenTypeDefinition(Module module, String augmentPackageName,
1098         String basePackageName, Type targetTypeRef, AugmentationSchema augSchema) {
1099         var Map<String, GeneratedTypeBuilder> augmentBuilders = genTypeBuilders.get(augmentPackageName);
1100         if (augmentBuilders === null) {
1101             augmentBuilders = new HashMap();
1102             genTypeBuilders.put(augmentPackageName, augmentBuilders);
1103         }
1104         val augIdentifier = getAugmentIdentifier(augSchema.unknownSchemaNodes);
1105
1106         val augTypeName = if (augIdentifier !== null) {
1107                 BindingMapping.getClassName(augIdentifier)
1108             } else {
1109                 augGenTypeName(augmentBuilders, targetTypeRef.name);
1110             }
1111
1112         val augTypeBuilder = new GeneratedTypeBuilderImpl(augmentPackageName, augTypeName);
1113
1114         augTypeBuilder.addImplementsType(DATA_OBJECT);
1115         augTypeBuilder.addImplementsType(Types.augmentationTypeFor(targetTypeRef));
1116         addImplementedInterfaceFromUses(augSchema, augTypeBuilder);
1117
1118         augSchemaNodeToMethods(module, basePackageName, augTypeBuilder, augTypeBuilder, augSchema.childNodes);
1119         augmentBuilders.put(augTypeName, augTypeBuilder);
1120         return augTypeBuilder;
1121     }
1122
1123     /**\r
1124      *\r
1125      * @param unknownSchemaNodes\r
1126      * @return nodeParameter of UnknownSchemaNode\r
1127      */
1128     private def String getAugmentIdentifier(List<UnknownSchemaNode> unknownSchemaNodes) {
1129         for (unknownSchemaNode : unknownSchemaNodes) {
1130             val nodeType = unknownSchemaNode.nodeType;
1131             if (AUGMENT_IDENTIFIER_NAME.equals(nodeType.localName) &&
1132                 YANG_EXT_NAMESPACE.equals(nodeType.namespace.toString())) {
1133                 return unknownSchemaNode.nodeParameter;
1134             }
1135         }
1136         return null;
1137     }
1138
1139     /**\r
1140      * Returns first unique name for the augment generated type builder. The\r
1141      * generated type builder name for augment consists from name of augmented\r
1142      * node and serial number of its augmentation.\r
1143      *\r
1144      * @param builders\r
1145      *            map of builders which were created in the package to which the\r
1146      *            augmentation belongs\r
1147      * @param genTypeName\r
1148      *            string with name of augmented node\r
1149      * @return string with unique name for augmentation builder\r
1150      */
1151     private def String augGenTypeName(Map<String, GeneratedTypeBuilder> builders, String genTypeName) {
1152         var index = 1;
1153         while ((builders !== null) && builders.containsKey(genTypeName + index)) {
1154             index = index + 1;
1155         }
1156         return genTypeName + index;
1157     }
1158
1159     /**\r
1160      * Adds the methods to <code>typeBuilder</code> which represent subnodes of\r
1161      * node for which <code>typeBuilder</code> was created.\r
1162      *\r
1163      * The subnodes aren't mapped to the methods if they are part of grouping or\r
1164      * augment (in this case are already part of them).\r
1165      *\r
1166      * @param module current module\r
1167      * @param basePackageName\r
1168      *            string contains the module package name\r
1169      * @param parent\r
1170      *            generated type builder which represents any node. The subnodes\r
1171      *            of this node are added to the <code>typeBuilder</code> as\r
1172      *            methods. The subnode can be of type leaf, leaf-list, list,\r
1173      *            container, choice.\r
1174      * @param childOf parent type\r
1175      * @param schemaNodes\r
1176      *            set of data schema nodes which are the children of the node\r
1177      *            for which <code>typeBuilder</code> was created\r
1178      * @return generated type builder which is the same builder as input\r
1179      *         parameter. The getter methods (representing child nodes) could be\r
1180      *         added to it.\r
1181      */
1182     private def GeneratedTypeBuilder resolveDataSchemaNodes(Module module, String basePackageName,
1183         GeneratedTypeBuilder parent, GeneratedTypeBuilder childOf, Set<DataSchemaNode> schemaNodes) {
1184         if ((schemaNodes !== null) && (parent !== null)) {
1185             for (schemaNode : schemaNodes) {
1186                 if (!schemaNode.augmenting && !schemaNode.addedByUses) {
1187                     addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, parent, childOf, module);
1188                 }
1189             }
1190         }
1191         return parent;
1192     }
1193
1194     /**\r
1195      * Adds the methods to <code>typeBuilder</code> what represents subnodes of\r
1196      * node for which <code>typeBuilder</code> was created.\r
1197      *\r
1198      * @param module current module\r
1199      * @param basePackageName\r
1200      *            string contains the module package name\r
1201      * @param typeBuilder\r
1202      *            generated type builder which represents any node. The subnodes\r
1203      *            of this node are added to the <code>typeBuilder</code> as\r
1204      *            methods. The subnode can be of type leaf, leaf-list, list,\r
1205      *            container, choice.\r
1206      * @param childOf parent type\r
1207      * @param schemaNodes\r
1208      *            set of data schema nodes which are the children of the node\r
1209      *            for which <code>typeBuilder</code> was created\r
1210      * @return generated type builder which is the same object as the input\r
1211      *         parameter <code>typeBuilder</code>. The getter method could be\r
1212      *         added to it.\r
1213      */
1214     private def GeneratedTypeBuilder augSchemaNodeToMethods(Module module, String basePackageName,
1215         GeneratedTypeBuilder typeBuilder, GeneratedTypeBuilder childOf, Set<DataSchemaNode> schemaNodes) {
1216         if ((schemaNodes !== null) && (typeBuilder !== null)) {
1217             for (schemaNode : schemaNodes) {
1218                 if (!schemaNode.isAugmenting()) {
1219                     addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder, childOf, module);
1220                 }
1221             }
1222         }
1223         return typeBuilder;
1224     }
1225
1226     /**\r
1227      * Adds to <code>typeBuilder</code> a method which is derived from\r
1228      * <code>schemaNode</code>.\r
1229      *\r
1230      * @param basePackageName\r
1231      *            string with the module package name\r
1232      * @param node\r
1233      *            data schema node which is added to <code>typeBuilder</code> as\r
1234      *            a method\r
1235      * @param typeBuilder\r
1236      *            generated type builder to which is <code>schemaNode</code>\r
1237      *            added as a method.\r
1238      * @param childOf parent type\r
1239      * @param module current module\r
1240      */
1241     private def void addSchemaNodeToBuilderAsMethod(String basePackageName, DataSchemaNode node,
1242         GeneratedTypeBuilder typeBuilder, GeneratedTypeBuilder childOf, Module module) {
1243         if (node !== null && typeBuilder !== null) {
1244             switch (node) {
1245                 case node instanceof LeafSchemaNode:
1246                     resolveLeafSchemaNodeAsMethod(typeBuilder, node as LeafSchemaNode)
1247                 case node instanceof LeafListSchemaNode:
1248                     resolveLeafListSchemaNode(typeBuilder, node as LeafListSchemaNode)
1249                 case node instanceof ContainerSchemaNode:
1250                     containerToGenType(module, basePackageName, typeBuilder, childOf, node as ContainerSchemaNode)
1251                 case node instanceof ListSchemaNode:
1252                     listToGenType(module, basePackageName, typeBuilder, childOf, node as ListSchemaNode)
1253                 case node instanceof ChoiceNode:
1254                     choiceToGeneratedType(module, basePackageName, typeBuilder, node as ChoiceNode)
1255             }
1256         }
1257     }
1258
1259     /**\r
1260      * Converts <code>choiceNode</code> to the list of generated types for\r
1261      * choice and its cases.\r
1262      *\r
1263      * The package names for choice and for its cases are created as\r
1264      * concatenation of the module package (<code>basePackageName</code>) and\r
1265      * names of all parents node.\r
1266      *\r
1267      * @param module current module\r
1268      * @param basePackageName\r
1269      *            string with the module package name\r
1270      * @param parent parent type\r
1271      * @param childOf concrete parent for case child nodes\r
1272      * @param choiceNode\r
1273      *            choice node which is mapped to generated type. Also child\r
1274      *            nodes - cases are mapped to generated types.\r
1275      * @throws IllegalArgumentException\r
1276      *             <ul>\r
1277      *             <li>if <code>basePackageName</code> equals null</li>\r
1278      *             <li>if <code>choiceNode</code> equals null</li>\r
1279      *             </ul>\r
1280      *\r
1281      */
1282     private def void choiceToGeneratedType(Module module, String basePackageName, GeneratedTypeBuilder parent,
1283         ChoiceNode choiceNode) {
1284         checkArgument(basePackageName !== null, "Base Package Name cannot be NULL.");
1285         checkArgument(choiceNode !== null, "Choice Schema Node cannot be NULL.");
1286
1287         if (!choiceNode.addedByUses) {
1288             val packageName = packageNameForGeneratedType(basePackageName, choiceNode.path);
1289             val choiceTypeBuilder = addRawInterfaceDefinition(packageName, choiceNode);
1290             constructGetter(parent, choiceNode.QName.localName, choiceNode.description, choiceTypeBuilder);
1291             choiceTypeBuilder.addImplementsType(DataContainer.typeForClass);
1292             genCtx.get(module).addChildNodeType(choiceNode.path, choiceTypeBuilder)
1293             generateTypesFromChoiceCases(module, basePackageName, parent, choiceTypeBuilder.toInstance, choiceNode);
1294         }
1295     }
1296
1297     /**\r
1298      * Converts <code>caseNodes</code> set to list of corresponding generated\r
1299      * types.\r
1300      *\r
1301      * For every <i>case</i> which isn't added through augment or <i>uses</i> is\r
1302      * created generated type builder. The package names for the builder is\r
1303      * created as concatenation of the module package (\r
1304      * <code>basePackageName</code>) and names of all parents nodes of the\r
1305      * concrete <i>case</i>. There is also relation "<i>implements type</i>"\r
1306      * between every case builder and <i>choice</i> type\r
1307      *\r
1308      * @param basePackageName\r
1309      *            string with the module package name\r
1310      * @param refChoiceType\r
1311      *            type which represents superior <i>case</i>\r
1312      * @param caseNodes\r
1313      *            set of choice case nodes which are mapped to generated types\r
1314      * @return list of generated types for <code>caseNodes</code>.\r
1315      * @throws IllegalArgumentException\r
1316      *             <ul>\r
1317      *             <li>if <code>basePackageName</code> equals null</li>\r
1318      *             <li>if <code>refChoiceType</code> equals null</li>\r
1319      *             <li>if <code>caseNodes</code> equals null</li>\r
1320      *             </ul>\r
1321      *             *\r
1322      */
1323     private def void generateTypesFromChoiceCases(Module module, String basePackageName,
1324         GeneratedTypeBuilder choiceParent, Type refChoiceType, ChoiceNode choiceNode) {
1325         checkArgument(basePackageName !== null, "Base Package Name cannot be NULL.");
1326         checkArgument(refChoiceType !== null, "Referenced Choice Type cannot be NULL.");
1327         checkArgument(choiceNode !== null, "ChoiceNode cannot be NULL.");
1328
1329         val Set<ChoiceCaseNode> caseNodes = choiceNode.cases;
1330         if (caseNodes == null) {
1331             return
1332         }
1333
1334         for (caseNode : caseNodes) {
1335             if (caseNode !== null && !caseNode.isAddedByUses() && !caseNode.isAugmenting()) {
1336                 val packageName = packageNameForGeneratedType(basePackageName, caseNode.path)
1337                 val caseTypeBuilder = addDefaultInterfaceDefinition(packageName, caseNode)
1338                 caseTypeBuilder.addImplementsType(refChoiceType)
1339                 genCtx.get(module).addCaseType(caseNode.path, caseTypeBuilder)
1340                 val Set<DataSchemaNode> caseChildNodes = caseNode.childNodes
1341                 if (caseChildNodes !== null) {
1342                     var Object parentNode = null\r
1343                     val SchemaPath nodeSp = choiceNode.path\r
1344                     val List<QName> nodeNames = nodeSp.path\r
1345                     val List<QName> nodeNewNames = new ArrayList(nodeNames)\r
1346                     nodeNewNames.remove(nodeNewNames.size - 1)\r
1347                     val SchemaPath nodeNewSp = new SchemaPath(nodeNewNames, nodeSp.absolute)\r
1348                     parentNode = findDataSchemaNode(schemaContext, nodeNewSp)\r
1349
1350                     var SchemaNode parent
1351                     if (parentNode instanceof AugmentationSchema) {
1352                         val augSchema = parentNode as AugmentationSchema;
1353                         val targetPath = augSchema.targetPath;
1354                         var targetSchemaNode = findDataSchemaNode(schemaContext, targetPath)
1355                         if (targetSchemaNode instanceof DataSchemaNode &&
1356                             (targetSchemaNode as DataSchemaNode).isAddedByUses()) {
1357                             targetSchemaNode = findOriginal(targetSchemaNode as DataSchemaNode);
1358                             if (targetSchemaNode == null) {
1359                                 throw new NullPointerException(
1360                                     "Failed to find target node from grouping for augmentation " + augSchema +
1361                                         " in module " + module.name);
1362                             }
1363                         }
1364                         parent = targetSchemaNode
1365                     } else {
1366                         val SchemaPath sp = choiceNode.path\r
1367                         val List<QName> names = sp.path\r
1368                         val List<QName> newNames = new ArrayList(names)\r
1369                         newNames.remove(newNames.size - 1)\r
1370                         val SchemaPath newSp = new SchemaPath(newNames, sp.absolute)\r
1371                         parent = findDataSchemaNode(schemaContext, newSp)\r
1372                     }
1373                     var GeneratedTypeBuilder childOfType = findChildNodeByPath(parent.path)
1374                     resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, childOfType, caseChildNodes)
1375                 }
1376             }
1377
1378             processUsesAugments(caseNode, module);
1379         }
1380     }
1381
1382     /**\r
1383      * Generates list of generated types for all the cases of a choice which are\r
1384      * added to the choice through the augment.\r
1385      *\r
1386      *\r
1387      * @param basePackageName\r
1388      *            string contains name of package to which augment belongs. If\r
1389      *            an augmented choice is from an other package (pcg1) than an\r
1390      *            augmenting choice (pcg2) then case's of the augmenting choice\r
1391      *            will belong to pcg2.\r
1392      * @param refChoiceType\r
1393      *            Type which represents the choice to which case belongs. Every\r
1394      *            case has to contain its choice in extend part.\r
1395      * @param caseNodes\r
1396      *            set of choice case nodes for which is checked if are/aren't\r
1397      *            added to choice through augmentation\r
1398      * @return list of generated types which represents augmented cases of\r
1399      *         choice <code>refChoiceType</code>\r
1400      * @throws IllegalArgumentException\r
1401      *             <ul>\r
1402      *             <li>if <code>basePackageName</code> equals null</li>\r
1403      *             <li>if <code>refChoiceType</code> equals null</li>\r
1404      *             <li>if <code>caseNodes</code> equals null</li>\r
1405      *             </ul>\r
1406      */
1407     private def void generateTypesFromAugmentedChoiceCases(Module module, String basePackageName, Type targetType,
1408         ChoiceNode targetNode, Set<DataSchemaNode> augmentedNodes) {
1409         checkArgument(basePackageName !== null, "Base Package Name cannot be NULL.");
1410         checkArgument(targetType !== null, "Referenced Choice Type cannot be NULL.");
1411         checkArgument(augmentedNodes !== null, "Set of Choice Case Nodes cannot be NULL.");
1412
1413         for (caseNode : augmentedNodes) {
1414             if (caseNode !== null) {
1415                 val packageName = packageNameForGeneratedType(basePackageName, caseNode.path);
1416                 val caseTypeBuilder = addDefaultInterfaceDefinition(packageName, caseNode);
1417                 caseTypeBuilder.addImplementsType(targetType);
1418
1419                 var SchemaNode parent = null\r
1420                 val SchemaPath nodeSp = targetNode.path\r
1421                 val List<QName> nodeNames = nodeSp.path\r
1422                 val List<QName> nodeNewNames = new ArrayList(nodeNames)\r
1423                 nodeNewNames.remove(nodeNewNames.size - 1)\r
1424                 val SchemaPath nodeNewSp = new SchemaPath(nodeNewNames, nodeSp.absolute)\r
1425                 parent = findDataSchemaNode(schemaContext, nodeNewSp)\r
1426
1427                 var GeneratedTypeBuilder childOfType = null;
1428                 if (parent instanceof Module) {
1429                     childOfType = genCtx.get(parent as Module).moduleNode
1430                 } else if (parent instanceof ChoiceCaseNode) {
1431                     childOfType = findCaseByPath(parent.path)
1432                 } else if (parent instanceof DataSchemaNode || parent instanceof NotificationDefinition) {
1433                     childOfType = findChildNodeByPath(parent.path)
1434                 } else if (parent instanceof GroupingDefinition) {
1435                     childOfType = findGroupingByPath(parent.path);
1436                 }
1437
1438                 if (childOfType == null) {
1439                     throw new IllegalArgumentException("Failed to find parent type of choice " + targetNode);
1440                 }
1441
1442                 if (caseNode instanceof DataNodeContainer) {
1443                     val DataNodeContainer dataNodeCase = caseNode as DataNodeContainer;
1444                     val Set<DataSchemaNode> childNodes = dataNodeCase.childNodes;
1445                     if (childNodes !== null) {
1446                         resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, childOfType, childNodes);
1447                     }
1448                 } else {
1449                     val ChoiceCaseNode node = targetNode.getCaseNodeByName(caseNode.getQName().getLocalName());
1450                     val Set<DataSchemaNode> childNodes = node.childNodes;
1451                     if (childNodes !== null) {
1452                         resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, childOfType, childNodes);
1453                     }
1454                 }
1455
1456                 genCtx.get(module).addCaseType(caseNode.path, caseTypeBuilder)
1457             }
1458         }
1459
1460     }
1461
1462     /**\r
1463      * Converts <code>leaf</code> to the getter method which is added to\r
1464      * <code>typeBuilder</code>.\r
1465      *\r
1466      * @param typeBuilder\r
1467      *            generated type builder to which is added getter method as\r
1468      *            <code>leaf</code> mapping\r
1469      * @param leaf\r
1470      *            leaf schema node which is mapped as getter method which is\r
1471      *            added to <code>typeBuilder</code>\r
1472      * @return boolean value\r
1473      *         <ul>\r
1474      *         <li>false - if <code>leaf</code> or <code>typeBuilder</code> are\r
1475      *         null</li>\r
1476      *         <li>true - in other cases</li>\r
1477      *         </ul>\r
1478      */
1479     private def boolean resolveLeafSchemaNodeAsMethod(GeneratedTypeBuilder typeBuilder, LeafSchemaNode leaf) {
1480         if ((leaf !== null) && (typeBuilder !== null)) {
1481             val leafName = leaf.QName.localName;
1482             var String leafDesc = leaf.description;
1483             if (leafDesc === null) {
1484                 leafDesc = "";
1485             }
1486
1487             val parentModule = findParentModule(schemaContext, leaf);
1488             if (leafName !== null && !leaf.isAddedByUses()) {
1489                 val TypeDefinition<?> typeDef = leaf.type;
1490
1491                 var Type returnType = null;
1492                 var GeneratedTOBuilder genTOBuilder;
1493                 if (typeDef instanceof EnumTypeDefinition) {
1494                     returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
1495                     val enumTypeDef = typeDef as EnumTypeDefinition;
1496                     val enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, leaf.QName, typeBuilder);
1497
1498                     if (enumBuilder !== null) {
1499                         returnType = new ReferencedTypeImpl(enumBuilder.packageName, enumBuilder.name);
1500                     }
1501                     (typeProvider as TypeProviderImpl).putReferencedType(leaf.path, returnType);
1502                 } else if (typeDef instanceof UnionType) {
1503                     genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule);\r
1504                     if (genTOBuilder !== null) {\r
1505                         returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule)\r
1506                     }
1507                 } else if (typeDef instanceof BitsTypeDefinition) {
1508                     genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule);\r
1509                     if (genTOBuilder !== null) {\r
1510                         returnType = new ReferencedTypeImpl(genTOBuilder.packageName, genTOBuilder.name);\r
1511                     }
1512                 } else {
1513                     val Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
1514                     returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, restrictions);
1515                 }
1516                 if (returnType !== null) {
1517                     val MethodSignatureBuilder getter = constructGetter(typeBuilder, leafName, leafDesc, returnType);
1518                     processContextRefExtension(leaf, getter, parentModule);
1519                     return true;
1520                 }
1521             }
1522         }
1523         return false;
1524     }
1525
1526     private def void processContextRefExtension(LeafSchemaNode leaf, MethodSignatureBuilder getter, Module module) {
1527         for (node : leaf.unknownSchemaNodes) {
1528             val nodeType = node.nodeType;
1529             if ("context-reference".equals(nodeType.localName)) {
1530                 val nodeParam = node.nodeParameter;
1531                 var IdentitySchemaNode identity = null;
1532                 var String basePackageName = null;
1533                 val String[] splittedElement = nodeParam.split(":");
1534                 if (splittedElement.length == 1) {
1535                     identity = findIdentityByName(module.identities, splittedElement.get(0));
1536                     basePackageName = moduleNamespaceToPackageName(module);
1537                 } else if (splittedElement.length == 2) {
1538                     var prefix = splittedElement.get(0);
1539                     val Module dependentModule = findModuleFromImports(module.imports, prefix)
1540                     if (dependentModule == null) {
1541                         throw new IllegalArgumentException(
1542                             "Failed to process context-reference: unknown prefix " + prefix);
1543                     }
1544                     identity = findIdentityByName(dependentModule.identities, splittedElement.get(1));
1545                     basePackageName = moduleNamespaceToPackageName(dependentModule);
1546                 } else {
1547                     throw new IllegalArgumentException(
1548                         "Failed to process context-reference: unknown identity " + nodeParam);
1549                 }
1550                 if (identity == null) {
1551                     throw new IllegalArgumentException(
1552                         "Failed to process context-reference: unknown identity " + nodeParam);
1553                 }
1554
1555                 val Class<RoutingContext> clazz = typeof(RoutingContext);
1556                 val AnnotationTypeBuilder rc = getter.addAnnotation(clazz.package.name, clazz.simpleName);
1557                 val packageName = packageNameForGeneratedType(basePackageName, identity.path);
1558                 val genTypeName = BindingMapping.getClassName(identity.QName.localName);
1559                 rc.addParameter("value", packageName + "." + genTypeName + ".class");
1560             }
1561         }
1562     }
1563
1564     private def IdentitySchemaNode findIdentityByName(Set<IdentitySchemaNode> identities, String name) {
1565         for (id : identities) {
1566             if (id.QName.localName.equals(name)) {
1567                 return id;
1568             }
1569         }
1570         return null;
1571     }
1572
1573     private def Module findModuleFromImports(Set<ModuleImport> imports, String prefix) {
1574         for (imp : imports) {
1575             if (imp.prefix.equals(prefix)) {
1576                 return schemaContext.findModuleByName(imp.moduleName, imp.revision);
1577             }
1578         }
1579         return null;
1580     }
1581
1582     /**\r
1583      * Converts <code>leaf</code> schema node to property of generated TO\r
1584      * builder.\r
1585      *\r
1586      * @param toBuilder\r
1587      *            generated TO builder to which is <code>leaf</code> added as\r
1588      *            property\r
1589      * @param leaf\r
1590      *            leaf schema node which is added to <code>toBuilder</code> as\r
1591      *            property\r
1592      * @param isReadOnly\r
1593      *            boolean value which says if leaf property is|isn't read only\r
1594      * @return boolean value\r
1595      *         <ul>\r
1596      *         <li>false - if <code>leaf</code>, <code>toBuilder</code> or leaf\r
1597      *         name equals null or if leaf is added by <i>uses</i>.</li>\r
1598      *         <li>true - other cases</li>\r
1599      *         </ul>\r
1600      */
1601     private def boolean resolveLeafSchemaNodeAsProperty(GeneratedTOBuilder toBuilder, LeafSchemaNode leaf,
1602         boolean isReadOnly, Module module) {
1603         if ((leaf !== null) && (toBuilder !== null)) {
1604             val leafName = leaf.QName.localName;
1605             var String leafDesc = leaf.description;
1606             if (leafDesc === null) {
1607                 leafDesc = "";
1608             }
1609
1610             if (leafName !== null) {\r
1611                 var Type returnType = null;
1612                 val TypeDefinition<?> typeDef = leaf.type;\r
1613                 if (typeDef instanceof UnionTypeDefinition) {\r
1614                     // GeneratedType for this type definition should be already created\r
1615                     var qname = typeDef.QName\r
1616                     var Module unionModule = null\r
1617                     if (qname.prefix == null || qname.prefix.empty) {\r
1618                         unionModule = module\r
1619                     } else {\r
1620                         unionModule = findModuleFromImports(module.imports, qname.prefix)\r
1621                     }\r
1622                     val ModuleContext mc = genCtx.get(unionModule)\r
1623                     returnType = mc.typedefs.get(typeDef.path)\r
1624                 } else {\r
1625                     returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);\r
1626                 }
1627
1628                 if (returnType !== null) {
1629                     val propBuilder = toBuilder.addProperty(parseToValidParamName(leafName));
1630                     propBuilder.setReadOnly(isReadOnly);
1631                     propBuilder.setReturnType(returnType);
1632                     propBuilder.setComment(leafDesc);
1633                     toBuilder.addEqualsIdentity(propBuilder);
1634                     toBuilder.addHashIdentity(propBuilder);
1635                     toBuilder.addToStringProperty(propBuilder);
1636                     return true;
1637                 }
1638             }
1639         }
1640         return false;
1641     }
1642
1643     /**\r
1644      * Converts <code>node</code> leaf list schema node to getter method of\r
1645      * <code>typeBuilder</code>.\r
1646      *\r
1647      * @param typeBuilder\r
1648      *            generated type builder to which is <code>node</code> added as\r
1649      *            getter method\r
1650      * @param node\r
1651      *            leaf list schema node which is added to\r
1652      *            <code>typeBuilder</code> as getter method\r
1653      * @return boolean value\r
1654      *         <ul>\r
1655      *         <li>true - if <code>node</code>, <code>typeBuilder</code>,\r
1656      *         nodeName equal null or <code>node</code> is added by <i>uses</i></li>\r
1657      *         <li>false - other cases</li>\r
1658      *         </ul>\r
1659      */
1660     private def boolean resolveLeafListSchemaNode(GeneratedTypeBuilder typeBuilder, LeafListSchemaNode node) {
1661         if ((node !== null) && (typeBuilder !== null)) {
1662             val nodeName = node.QName;
1663             var String nodeDesc = node.description;
1664             if (nodeDesc === null) {
1665                 nodeDesc = "";
1666             }
1667             if (nodeName !== null && !node.isAddedByUses()) {
1668                 val TypeDefinition<?> typeDef = node.type;\r
1669                 val parentModule = findParentModule(schemaContext, node);\r
1670 \r
1671                 var Type returnType = null;\r
1672                 if (typeDef instanceof EnumTypeDefinition) {\r
1673                     returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node);\r
1674                     val enumTypeDef = typeDef as EnumTypeDefinition;\r
1675                     val enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, nodeName, typeBuilder);\r
1676                     returnType = new ReferencedTypeImpl(enumBuilder.packageName, enumBuilder.name);\r
1677                     (typeProvider as TypeProviderImpl).putReferencedType(node.path, returnType);\r
1678                 } else if (typeDef instanceof UnionType) {\r
1679                     val genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule);\r
1680                     if (genTOBuilder !== null) {\r
1681                         returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule)\r
1682                     }
1683                 } else if (typeDef instanceof BitsTypeDefinition) {\r
1684                     val genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule);\r
1685                     returnType = new ReferencedTypeImpl(genTOBuilder.packageName, genTOBuilder.name);\r
1686                 } else {\r
1687                     val Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);\r
1688                     returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, restrictions);\r
1689                 }\r
1690
1691                 val listType = Types.listTypeFor(returnType);
1692                 constructGetter(typeBuilder, nodeName.localName, nodeDesc, listType);
1693                 return true;
1694             }
1695         }
1696         return false;
1697     }
1698 \r
1699     private def Type createReturnTypeForUnion(GeneratedTOBuilder genTOBuilder, TypeDefinition<?> typeDef,
1700         GeneratedTypeBuilder typeBuilder, Module parentModule) {
1701         val Type returnType = new ReferencedTypeImpl(genTOBuilder.packageName, genTOBuilder.name);
1702         genTOBuilder.setTypedef(true);
1703         genTOBuilder.setIsUnion(true);
1704         (typeProvider as TypeProviderImpl).addUnitsToGenTO(genTOBuilder, typeDef.getUnits());
1705
1706         // union builder\r
1707         val GeneratedTOBuilder unionBuilder = new GeneratedTOBuilderImpl(typeBuilder.getPackageName(),
1708             genTOBuilder.getName() + "Builder");
1709         unionBuilder.setIsUnionBuilder(true);
1710         val MethodSignatureBuilder method = unionBuilder.addMethod("getDefaultInstance");
1711         method.setReturnType(returnType);
1712         method.addParameter(Types.STRING, "defaultValue");
1713         method.setAccessModifier(AccessModifier.PUBLIC);
1714         method.setStatic(true);
1715
1716         val Set<Type> types = (typeProvider as TypeProviderImpl).additionalTypes.get(parentModule);
1717         if (types == null) {
1718             (typeProvider as TypeProviderImpl).additionalTypes.put(parentModule,
1719                 Sets.newHashSet(unionBuilder.toInstance))
1720         } else {
1721             types.add(unionBuilder.toInstance)
1722         }
1723         return returnType
1724     }\r
1725
1726     private def GeneratedTypeBuilder addDefaultInterfaceDefinition(String packageName, SchemaNode schemaNode) {
1727         return addDefaultInterfaceDefinition(packageName, schemaNode, null);
1728     }
1729
1730     /**\r
1731      * Instantiates generated type builder with <code>packageName</code> and\r
1732      * <code>schemaNode</code>.\r
1733      *\r
1734      * The new builder always implements\r
1735      * {@link org.opendaylight.yangtools.yang.binding.DataObject DataObject}.<br />\r
1736      * If <code>schemaNode</code> is instance of GroupingDefinition it also\r
1737      * implements {@link org.opendaylight.yangtools.yang.binding.Augmentable\r
1738      * Augmentable}.<br />\r
1739      * If <code>schemaNode</code> is instance of\r
1740      * {@link org.opendaylight.yangtools.yang.model.api.DataNodeContainer\r
1741      * DataNodeContainer} it can also implement nodes which are specified in\r
1742      * <i>uses</i>.\r
1743      *\r
1744      * @param packageName\r
1745      *            string with the name of the package to which\r
1746      *            <code>schemaNode</code> belongs.\r
1747      * @param schemaNode\r
1748      *            schema node for which is created generated type builder\r
1749      * @param parent parent type (can be null)\r
1750      * @return generated type builder <code>schemaNode</code>\r
1751      */
1752     private def GeneratedTypeBuilder addDefaultInterfaceDefinition(String packageName, SchemaNode schemaNode,
1753         Type parent) {
1754         val it = addRawInterfaceDefinition(packageName, schemaNode, "");\r
1755         qnameConstant(BindingMapping.QNAME_STATIC_FIELD_NAME,schemaNode.QName);\r
1756         if (parent === null) {
1757             addImplementsType(DATA_OBJECT);
1758         } else {
1759             addImplementsType(BindingTypes.childOf(parent));
1760         }
1761         if (!(schemaNode instanceof GroupingDefinition)) {
1762             addImplementsType(augmentable(it));
1763         }
1764
1765         if (schemaNode instanceof DataNodeContainer) {
1766             addImplementedInterfaceFromUses(schemaNode as DataNodeContainer, it);
1767         }
1768
1769         return it;
1770     }
1771
1772     /**\r
1773      * Wraps the calling of the same overloaded method.\r
1774      *\r
1775      * @param packageName\r
1776      *            string with the package name to which returning generated type\r
1777      *            builder belongs\r
1778      * @param schemaNode\r
1779      *            schema node which provide data about the schema node name\r
1780      * @return generated type builder for <code>schemaNode</code>\r
1781      */
1782     private def GeneratedTypeBuilder addRawInterfaceDefinition(String packageName, SchemaNode schemaNode) {
1783         return addRawInterfaceDefinition(packageName, schemaNode, "");
1784     }
1785
1786     /**\r
1787      * Returns reference to generated type builder for specified\r
1788      * <code>schemaNode</code> with <code>packageName</code>.\r
1789      *\r
1790      * Firstly the generated type builder is searched in\r
1791      * {@link BindingGeneratorImpl#genTypeBuilders genTypeBuilders}. If it isn't\r
1792      * found it is created and added to <code>genTypeBuilders</code>.\r
1793      *\r
1794      * @param packageName\r
1795      *            string with the package name to which returning generated type\r
1796      *            builder belongs\r
1797      * @param schemaNode\r
1798      *            schema node which provide data about the schema node name\r
1799      * @param prefix return type name prefix\r
1800      * @return generated type builder for <code>schemaNode</code>\r
1801      * @throws IllegalArgumentException\r
1802      *             <ul>\r
1803      *             <li>if <code>schemaNode</code> equals null</li>\r
1804      *             <li>if <code>packageName</code> equals null</li>\r
1805      *             <li>if Q name of schema node is null</li>\r
1806      *             <li>if schema node name is null</li>\r
1807      *             </ul>\r
1808      *\r
1809      */
1810     private def GeneratedTypeBuilder addRawInterfaceDefinition(String packageName, SchemaNode schemaNode,
1811         String prefix) {
1812         checkArgument(schemaNode !== null, "Data Schema Node cannot be NULL.");
1813         checkArgument(packageName !== null, "Package Name for Generated Type cannot be NULL.");
1814         checkArgument(schemaNode.QName !== null, "QName for Data Schema Node cannot be NULL.");
1815         val schemaNodeName = schemaNode.QName.localName;
1816         checkArgument(schemaNodeName !== null, "Local Name of QName for Data Schema Node cannot be NULL.");
1817
1818         var String genTypeName;
1819         if (prefix === null) {
1820             genTypeName = BindingMapping.getClassName(schemaNodeName);
1821         } else {
1822             genTypeName = prefix + BindingMapping.getClassName(schemaNodeName);
1823         }
1824
1825         //FIXME: Validation of name conflict\r
1826         val newType = new GeneratedTypeBuilderImpl(packageName, genTypeName);
1827         if (!genTypeBuilders.containsKey(packageName)) {
1828             val Map<String, GeneratedTypeBuilder> builders = new HashMap();
1829             builders.put(genTypeName, newType);
1830             genTypeBuilders.put(packageName, builders);
1831         } else {
1832             val Map<String, GeneratedTypeBuilder> builders = genTypeBuilders.get(packageName);
1833             if (!builders.containsKey(genTypeName)) {
1834                 builders.put(genTypeName, newType);
1835             }
1836         }
1837         return newType;
1838     }
1839
1840     /**\r
1841      * Creates the name of the getter method from <code>methodName</code>.\r
1842      *\r
1843      * @param methodName\r
1844      *            string with the name of the getter method\r
1845      * @param returnType return type\r
1846      * @return string with the name of the getter method for\r
1847      *         <code>methodName</code> in JAVA method format\r
1848      */
1849     public static def String getterMethodName(String localName, Type returnType) {
1850         val method = new StringBuilder();
1851         if (BOOLEAN.equals(returnType)) {
1852             method.append("is");
1853         } else {
1854             method.append("get");
1855         }
1856         method.append(BindingMapping.getPropertyName(localName).toFirstUpper);
1857         return method.toString();
1858     }
1859
1860     /**\r
1861      * Created a method signature builder as part of\r
1862      * <code>interfaceBuilder</code>.\r
1863      *\r
1864      * The method signature builder is created for the getter method of\r
1865      * <code>schemaNodeName</code>. Also <code>comment</code> and\r
1866      * <code>returnType</code> information are added to the builder.\r
1867      *\r
1868      * @param interfaceBuilder\r
1869      *            generated type builder for which the getter method should be\r
1870      *            created\r
1871      * @param schemaNodeName\r
1872      *            string with schema node name. The name will be the part of the\r
1873      *            getter method name.\r
1874      * @param comment\r
1875      *            string with comment for the getter method\r
1876      * @param returnType\r
1877      *            type which represents the return type of the getter method\r
1878      * @return method signature builder which represents the getter method of\r
1879      *         <code>interfaceBuilder</code>\r
1880      */
1881     private def MethodSignatureBuilder constructGetter(GeneratedTypeBuilder interfaceBuilder, String schemaNodeName,
1882         String comment, Type returnType) {
1883         val getMethod = interfaceBuilder.addMethod(getterMethodName(schemaNodeName, returnType));
1884         getMethod.setComment(comment);
1885         getMethod.setReturnType(returnType);
1886         return getMethod;
1887     }
1888
1889     /**\r
1890      * Adds <code>schemaNode</code> to <code>typeBuilder</code> as getter method\r
1891      * or to <code>genTOBuilder</code> as property.\r
1892      *\r
1893      * @param basePackageName\r
1894      *            string contains the module package name\r
1895      * @param schemaNode\r
1896      *            data schema node which should be added as getter method to\r
1897      *            <code>typeBuilder</code> or as a property to\r
1898      *            <code>genTOBuilder</code> if is part of the list key\r
1899      * @param typeBuilder\r
1900      *            generated type builder for the list schema node\r
1901      * @param genTOBuilder\r
1902      *            generated TO builder for the list keys\r
1903      * @param listKeys\r
1904      *            list of string which contains names of the list keys\r
1905      * @param module current module\r
1906      * @throws IllegalArgumentException\r
1907      *             <ul>\r
1908      *             <li>if <code>schemaNode</code> equals null</li>\r
1909      *             <li>if <code>typeBuilder</code> equals null</li>\r
1910      *             </ul>\r
1911      */
1912     private def void addSchemaNodeToListBuilders(String basePackageName, DataSchemaNode schemaNode,
1913         GeneratedTypeBuilder typeBuilder, GeneratedTOBuilder genTOBuilder, List<String> listKeys, Module module) {
1914         checkArgument(schemaNode !== null, "Data Schema Node cannot be NULL.");
1915         checkArgument(typeBuilder !== null, "Generated Type Builder cannot be NULL.");
1916
1917         if (schemaNode instanceof LeafSchemaNode) {
1918             val leaf = schemaNode as LeafSchemaNode;
1919             val leafName = leaf.QName.localName;\r
1920             resolveLeafSchemaNodeAsMethod(typeBuilder, leaf);
1921             if (listKeys.contains(leafName)) {
1922                 resolveLeafSchemaNodeAsProperty(genTOBuilder, leaf, true, module)
1923             }
1924         } else if (!schemaNode.addedByUses) {
1925             if (schemaNode instanceof LeafListSchemaNode) {
1926                 resolveLeafListSchemaNode(typeBuilder, schemaNode as LeafListSchemaNode);
1927             } else if (schemaNode instanceof ContainerSchemaNode) {
1928                 containerToGenType(module, basePackageName, typeBuilder, typeBuilder, schemaNode as ContainerSchemaNode);
1929             } else if (schemaNode instanceof ChoiceNode) {
1930                 choiceToGeneratedType(module, basePackageName, typeBuilder, schemaNode as ChoiceNode);
1931             } else if (schemaNode instanceof ListSchemaNode) {
1932                 listToGenType(module, basePackageName, typeBuilder, typeBuilder, schemaNode as ListSchemaNode);
1933             }
1934         }
1935     }
1936
1937     private def typeBuildersToGenTypes(Module module, GeneratedTypeBuilder typeBuilder, GeneratedTOBuilder genTOBuilder) {
1938         checkArgument(typeBuilder !== null, "Generated Type Builder cannot be NULL.");
1939
1940         if (genTOBuilder !== null) {
1941             val genTO = genTOBuilder.toInstance();
1942             constructGetter(typeBuilder, "key", "Returns Primary Key of Yang List Type", genTO);
1943             genCtx.get(module).addGeneratedTOBuilder(genTOBuilder)
1944         }
1945     }
1946
1947     /**\r
1948      * Selects the names of the list keys from <code>list</code> and returns\r
1949      * them as the list of the strings\r
1950      *\r
1951      * @param list\r
1952      *            of string with names of the list keys\r
1953      * @return list of string which represents names of the list keys. If the\r
1954      *         <code>list</code> contains no keys then the empty list is\r
1955      *         returned.\r
1956      */
1957     private def listKeys(ListSchemaNode list) {
1958         val List<String> listKeys = new ArrayList();
1959
1960         if (list.keyDefinition !== null) {
1961             val keyDefinitions = list.keyDefinition;
1962             for (keyDefinition : keyDefinitions) {
1963                 listKeys.add(keyDefinition.localName);
1964             }
1965         }
1966         return listKeys;
1967     }
1968
1969     /**\r
1970      * Generates for the <code>list</code> which contains any list keys special\r
1971      * generated TO builder.\r
1972      *\r
1973      * @param packageName\r
1974      *            string with package name to which the list belongs\r
1975      * @param list\r
1976      *            list schema node which is source of data about the list name\r
1977      * @return generated TO builder which represents the keys of the\r
1978      *         <code>list</code> or null if <code>list</code> is null or list of\r
1979      *         key definitions is null or empty.\r
1980      */
1981     private def GeneratedTOBuilder resolveListKeyTOBuilder(String packageName, ListSchemaNode list) {
1982         var GeneratedTOBuilder genTOBuilder = null;
1983         if ((list.keyDefinition !== null) && (!list.keyDefinition.isEmpty())) {
1984             val listName = list.QName.localName + "Key";
1985             val String genTOName = BindingMapping.getClassName(listName);
1986             genTOBuilder = new GeneratedTOBuilderImpl(packageName, genTOName);
1987         }
1988         return genTOBuilder;
1989     }
1990
1991     /**\r
1992      * Builds generated TO builders for <code>typeDef</code> of type\r
1993      * {@link org.opendaylight.yangtools.yang.model.util.UnionType UnionType} or\r
1994      * {@link org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition\r
1995      * BitsTypeDefinition} which are also added to <code>typeBuilder</code> as\r
1996      * enclosing transfer object.\r
1997      *\r
1998      * If more then one generated TO builder is created for enclosing then all\r
1999      * of the generated TO builders are added to <code>typeBuilder</code> as\r
2000      * enclosing transfer objects.\r
2001      *\r
2002      * @param typeDef\r
2003      *            type definition which can be of type <code>UnionType</code> or\r
2004      *            <code>BitsTypeDefinition</code>\r
2005      * @param typeBuilder\r
2006      *            generated type builder to which is added generated TO created\r
2007      *            from <code>typeDef</code>\r
2008      * @param leafName\r
2009      *            string with name for generated TO builder\r
2010      * @param leaf\r
2011      * @param parentModule\r
2012      * @return generated TO builder for <code>typeDef</code>\r
2013      */
2014     private def GeneratedTOBuilder addTOToTypeBuilder(TypeDefinition<?> typeDef, GeneratedTypeBuilder typeBuilder,
2015         DataSchemaNode leaf, Module parentModule) {
2016         val classNameFromLeaf = BindingMapping.getClassName(leaf.QName);
2017         val List<GeneratedTOBuilder> genTOBuilders = new ArrayList();
2018         val packageName = typeBuilder.fullyQualifiedName;
2019         if (typeDef instanceof UnionTypeDefinition) {\r
2020             val List<GeneratedTOBuilder> types = (typeProvider as TypeProviderImpl).\r
2021                     provideGeneratedTOBuildersForUnionTypeDef(packageName, (typeDef as UnionTypeDefinition),\r
2022                         classNameFromLeaf, leaf); 
2023             genTOBuilders.addAll(types);\r
2024                         \r
2025             \r
2026         var GeneratedTOBuilder resultTOBuilder = null;\r
2027         if (!types.isEmpty()) {\r
2028             resultTOBuilder = types.remove(0);\r
2029             for (GeneratedTOBuilder genTOBuilder : types) {\r
2030                 resultTOBuilder.addEnclosingTransferObject(genTOBuilder);\r
2031             }\r
2032         }\r
2033 \r
2034         val GeneratedPropertyBuilder genPropBuilder = resultTOBuilder.addProperty("value");\r
2035         genPropBuilder.setReturnType(Types.primitiveType("char[]", null));\r
2036         resultTOBuilder.addEqualsIdentity(genPropBuilder);\r
2037         resultTOBuilder.addHashIdentity(genPropBuilder);\r
2038         resultTOBuilder.addToStringProperty(genPropBuilder);\r
2039
2040         } else if (typeDef instanceof BitsTypeDefinition) {
2041             genTOBuilders.add(
2042                 ((typeProvider as TypeProviderImpl) ).
2043                     provideGeneratedTOBuilderForBitsTypeDefinition(packageName, typeDef, classNameFromLeaf));
2044         }
2045         if (genTOBuilders !== null && !genTOBuilders.isEmpty()) {
2046             for (genTOBuilder : genTOBuilders) {
2047                 typeBuilder.addEnclosingTransferObject(genTOBuilder);
2048             }
2049             return genTOBuilders.get(0);
2050         }
2051         return null;
2052
2053     }
2054
2055     /**\r
2056      * Adds the implemented types to type builder.\r
2057      *\r
2058      * The method passes through the list of <i>uses</i> in\r
2059      * {@code dataNodeContainer}. For every <i>use</i> is obtained corresponding\r
2060      * generated type from {@link BindingGeneratorImpl#allGroupings\r
2061      * allGroupings} which is added as <i>implements type</i> to\r
2062      * <code>builder</code>\r
2063      *\r
2064      * @param dataNodeContainer\r
2065      *            element which contains the list of used YANG groupings\r
2066      * @param builder\r
2067      *            builder to which are added implemented types according to\r
2068      *            <code>dataNodeContainer</code>\r
2069      * @return generated type builder with all implemented types\r
2070      */
2071     private def addImplementedInterfaceFromUses(DataNodeContainer dataNodeContainer, GeneratedTypeBuilder builder) {
2072         for (usesNode : dataNodeContainer.uses) {
2073             if (usesNode.groupingPath !== null) {
2074                 val genType = findGroupingByPath(usesNode.groupingPath).toInstance
2075                 if (genType === null) {
2076                     throw new IllegalStateException(
2077                         "Grouping " + usesNode.groupingPath + "is not resolved for " + builder.name);
2078                 }
2079                 builder.addImplementsType(genType);
2080             }
2081         }
2082         return builder;
2083     }
2084
2085     private def GeneratedTypeBuilder findChildNodeByPath(SchemaPath path) {
2086         for (ctx : genCtx.values) {
2087             var result = ctx.getChildNode(path)
2088             if (result !== null) {
2089                 return result
2090             }
2091         }
2092         return null
2093     }
2094
2095     private def GeneratedTypeBuilder findGroupingByPath(SchemaPath path) {
2096         for (ctx : genCtx.values) {
2097             var result = ctx.getGrouping(path)
2098             if (result !== null) {
2099                 return result
2100             }
2101         }
2102         return null
2103     }
2104
2105     private def GeneratedTypeBuilder findCaseByPath(SchemaPath path) {
2106         for (ctx : genCtx.values) {
2107             var result = ctx.getCase(path)
2108             if (result !== null) {
2109                 return result
2110             }
2111         }
2112         return null
2113     }
2114 \r
2115     private def Module getParentModule(SchemaNode node) {\r
2116         val QName qname = node.getPath().getPath().get(0);\r
2117         val URI namespace = qname.getNamespace();\r
2118         val Date revision = qname.getRevision();\r
2119         return schemaContext.findModuleByNamespaceAndRevision(namespace, revision);\r
2120     }\r
2121 \r
2122     public def getModuleContexts() {\r
2123         genCtx;\r
2124     }\r
2125 \r
2126 }