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
  10 import java.util.ArrayList;
  11 import java.util.Collections;
  12 import java.util.HashMap;
  13 import java.util.List;
  14 import java.util.Map;
  15 import java.util.Set;
  16 import org.opendaylight.yangtools.binding.generator.util.BindingTypes;
  17 import org.opendaylight.yangtools.binding.generator.util.ReferencedTypeImpl;
  18 import org.opendaylight.yangtools.binding.generator.util.Types;
  19 import org.opendaylight.yangtools.binding.generator.util.generated.type.builder.GeneratedTOBuilderImpl;
  20 import org.opendaylight.yangtools.binding.generator.util.generated.type.builder.GeneratedTypeBuilderImpl;
  21 import org.opendaylight.yangtools.sal.binding.generator.api.BindingGenerator;
  22 import org.opendaylight.yangtools.sal.binding.generator.spi.TypeProvider;
  23 import org.opendaylight.yangtools.sal.binding.model.api.AccessModifier;
  24 import org.opendaylight.yangtools.sal.binding.model.api.Type;
  25 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.EnumBuilder;
  26 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedTOBuilder;
  27 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedTypeBuilder;
  28 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.MethodSignatureBuilder;
  29 import org.opendaylight.yangtools.sal.binding.yang.types.GroupingDefinitionDependencySort;
  30 import org.opendaylight.yangtools.sal.binding.yang.types.TypeProviderImpl;
  31 import org.opendaylight.yangtools.yang.binding.RpcService;
  32 import org.opendaylight.yangtools.yang.common.RpcResult;
  33 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
  34 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
  35 import org.opendaylight.yangtools.yang.model.api.ChoiceNode;
  36 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  37 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  38 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  39 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
  40 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
  41 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
  42 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  43 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  44 import org.opendaylight.yangtools.yang.model.api.Module;
  45 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  46 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  47 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  48 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  49 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  50 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
  51 import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition;
  52 import org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition;
  53 import org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition;
  54 import org.opendaylight.yangtools.yang.model.util.DataNodeIterator;
  55 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
  56 import org.opendaylight.yangtools.yang.model.util.UnionType;
  57 import static com.google.common.base.Preconditions.*;
  58 import static extension org.opendaylight.yangtools.binding.generator.util.Types.*;
  59 import static org.opendaylight.yangtools.binding.generator.util.BindingGeneratorUtil.*;
  60 import static org.opendaylight.yangtools.binding.generator.util.BindingTypes.*;
  61 import static org.opendaylight.yangtools.yang.model.util.SchemaContextUtil.*;
  62 import org.opendaylight.yangtools.yang.parser.util.ModuleDependencySort
  63 import org.opendaylight.yangtools.yang.model.util.ExtendedType;
  64 import org.opendaylight.yangtools.yang.model.api.UsesNode
  65 import org.opendaylight.yangtools.yang.binding.annotations.RoutingContext
  66 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.AnnotationTypeBuilder
  67 import org.opendaylight.yangtools.yang.model.api.ModuleImport
  68 import org.opendaylight.yangtools.yang.binding.DataContainer
  69 import java.util.Iterator
  70 import org.opendaylight.yangtools.yang.model.api.AugmentationTarget
  71 import java.util.Collection
  72 import org.opendaylight.yangtools.yang.model.api.YangNode
  73 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition
  74 import org.opendaylight.yangtools.binding.generator.util.BindingGeneratorUtil
  75 import org.opendaylight.yangtools.sal.binding.model.api.Restrictions
  76 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedPropertyBuilder
  77 import org.opendaylight.yangtools.binding.generator.util.generated.type.builder.GeneratedPropertyBuilderImpl
  78
  79 import org.opendaylight.yangtools.yang.common.QName\rimport org.opendaylight.yangtools.yang.binding.BindingMapping
  80 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedTypeBuilderBase
  81
  82 import org.opendaylight.yangtools.yang.common.QName\rimport com.google.common.collect.Sets
  83
  84
  85 public class BindingGeneratorImpl implements BindingGenerator {
  86
  87     private final Map<Module, ModuleContext> genCtx = new HashMap()
  88
  89     /**\r
  90      * Outter key represents the package name. Outter 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 elemnt\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                 augmentationToGenTypes(basePackageName, augment, module, usesNode);
 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, null);
 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 dependend (indepedent) 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 recursivelly 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 contais 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 agumentation\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         UsesNode parentUsesNode) {
 736         checkArgument(augmentPackageName !== null, "Package Name cannot be NULL.");
 737         checkArgument(augSchema !== null, "Augmentation Schema cannot be NULL.");
 738         checkState(augSchema.targetPath !== null,
 739             "Augmentation Schema does not contain Target Path (Target Path is NULL).");
 740
 741         processUsesAugments(augSchema, module);
 742
 743         // EVERY augmented interface will extends Augmentation<T> interface\r
 744         // and DataObject interface\r
 745         val targetPath = augSchema.targetPath;
 746         var targetSchemaNode = findDataSchemaNode(schemaContext, targetPath);
 747         if (targetSchemaNode instanceof DataSchemaNode && (targetSchemaNode as DataSchemaNode).isAddedByUses()) {
 748             if (parentUsesNode == null) {
 749                 targetSchemaNode = findOriginal(targetSchemaNode as DataSchemaNode);
 750             } else {
 751                 targetSchemaNode = findOriginalTargetFromGrouping(targetSchemaNode.QName.localName, parentUsesNode);
 752             }
 753             if (targetSchemaNode == null) {
 754                 throw new NullPointerException(
 755                     "Failed to find target node from grouping for augmentation " + augSchema + " in module " +
 756                         module.name);
 757             }
 758         }\r
 759
 760         if (targetSchemaNode !== null) {
 761             var targetTypeBuilder = findChildNodeByPath(targetSchemaNode.path)
 762             if (targetTypeBuilder === null) {
 763                 targetTypeBuilder = findCaseByPath(targetSchemaNode.path)
 764             }
 765             if (targetTypeBuilder === null) {
 766                 throw new NullPointerException("Target type not yet generated: " + targetSchemaNode);
 767             }
 768             if (!(targetSchemaNode instanceof ChoiceNode)) {
 769                 var packageName = augmentPackageName;
 770                 if (parentUsesNode != null) {
 771                     packageName = packageNameForGeneratedType(augmentPackageName, augSchema.targetPath);
 772                 }
 773                 val augTypeBuilder = addRawAugmentGenTypeDefinition(module, packageName, augmentPackageName,
 774                     targetTypeBuilder.toInstance, augSchema);
 775                 genCtx.get(module).addAugmentType(augTypeBuilder)\r
 776                 genCtx.get(module).addTypeToAugmentation(augTypeBuilder,augSchema);
 777             } else {
 778                 generateTypesFromAugmentedChoiceCases(module, augmentPackageName, targetTypeBuilder.toInstance,
 779                     targetSchemaNode as ChoiceNode, augSchema.childNodes);
 780             }
 781         }
 782     }
 783
 784     /**\r
 785      * Utility method which search for original node defined in grouping.\r
 786      */
 787     private def DataSchemaNode findOriginal(DataSchemaNode node) {
 788         var DataSchemaNode result = findCorrectTargetFromGrouping(node);
 789         if (result == null) {
 790             result = findCorrectTargetFromAugment(node);
 791             if (result != null) {
 792                 if (result.addedByUses) {
 793                     result = findOriginal(result);
 794                 }
 795             }
 796         }
 797         return result;
 798     }
 799
 800     private def DataSchemaNode findCorrectTargetFromAugment(DataSchemaNode node) {
 801         if (!node.augmenting) {
 802             return null;
 803         }
 804
 805         var String currentName = node.QName.localName;
 806         var tmpPath = new ArrayList<String>();
 807         var YangNode parent = node;
 808         var AugmentationSchema augment = null;
 809         do {
 810             parent = (parent as DataSchemaNode).parent;
 811             if (parent instanceof AugmentationTarget) {
 812                 tmpPath.add(currentName);
 813                 augment = findNodeInAugment((parent as AugmentationTarget).availableAugmentations, currentName);
 814                 if (augment == null) {
 815                     currentName = (parent as DataSchemaNode).QName.localName;
 816                 }
 817             }
 818         } while ((parent as DataSchemaNode).augmenting && augment == null);
 819
 820         if (augment == null) {
 821             return null;
 822         } else {
 823             Collections.reverse(tmpPath);
 824             var Object actualParent = augment;
 825             var DataSchemaNode result = null;
 826             for (name : tmpPath) {
 827                 if (actualParent instanceof DataNodeContainer) {
 828                     result = (actualParent as DataNodeContainer).getDataChildByName(name);
 829                     actualParent = (actualParent as DataNodeContainer).getDataChildByName(name);
 830                 } else {
 831                     if (actualParent instanceof ChoiceNode) {
 832                         result = (actualParent as ChoiceNode).getCaseNodeByName(name);
 833                         actualParent = (actualParent as ChoiceNode).getCaseNodeByName(name);
 834                     }
 835                 }
 836             }
 837
 838             if (result.addedByUses) {
 839                 result = findCorrectTargetFromGrouping(result);
 840             }
 841
 842             return result;
 843         }
 844     }
 845
 846     private def AugmentationSchema findNodeInAugment(Collection<AugmentationSchema> augments, String name) {
 847         for (augment : augments) {
 848             if (augment.getDataChildByName(name) != null) {
 849                 return augment;
 850             }
 851         }
 852         return null;
 853     }
 854
 855     private def DataSchemaNode findCorrectTargetFromGrouping(DataSchemaNode node) {
 856         if (node.path.path.size == 1) {
 857
 858             // uses is under module statement\r
 859             val Module m = findParentModule(schemaContext, node);
 860             var DataSchemaNode result = null;
 861             for (u : m.uses) {
 862                 var SchemaNode targetGrouping = findNodeInSchemaContext(schemaContext, u.groupingPath.path);
 863                 if (!(targetGrouping instanceof GroupingDefinition)) {
 864                     throw new IllegalArgumentException("Failed to generate code for augment in " + u);
 865                 }
 866                 var gr = targetGrouping as GroupingDefinition;
 867                 result = gr.getDataChildByName(node.QName.localName);
 868             }
 869             if (result == null) {
 870                 throw new IllegalArgumentException("Failed to generate code for augment");
 871             }
 872             return result;
 873         } else {
 874             var DataSchemaNode result = null;
 875             var String currentName = node.QName.localName;
 876             var tmpPath = new ArrayList<String>();
 877             var YangNode parent = node.parent;
 878             do {
 879                 tmpPath.add(currentName);
 880                 val dataNodeParent = parent as DataNodeContainer;
 881                 for (u : dataNodeParent.uses) {
 882                     if (result == null) {\r
 883                         var SchemaNode targetGrouping = findNodeInSchemaContext(schemaContext, u.groupingPath.path);
 884                         if (!(targetGrouping instanceof GroupingDefinition)) {
 885                             throw new IllegalArgumentException("Failed to generate code for augment in " + u);
 886                         }
 887                         var gr = targetGrouping as GroupingDefinition;
 888                         result = gr.getDataChildByName(currentName);\r
 889                     }
 890                 }
 891                 if (result == null) {
 892                     currentName = (parent as SchemaNode).QName.localName;
 893                     if (parent instanceof DataSchemaNode) {
 894                         parent = (parent as DataSchemaNode).parent;
 895                     } else {
 896                         parent = (parent as DataNodeContainer).parent;
 897                     }
 898                 }
 899             } while (result == null && !(parent instanceof Module));
 900
 901             if (result != null) {
 902                 if (tmpPath.size == 1) {\r
 903                     if (result != null && result.addedByUses) {\r
 904                         result = findOriginal(result);\r
 905                     }
 906                     return result;
 907                 } else {
 908                     var DataSchemaNode newParent = result;
 909                     Collections.reverse(tmpPath);
 910                     tmpPath.remove(0);
 911                     for (name : tmpPath) {
 912                         newParent = (newParent as DataNodeContainer).getDataChildByName(name);
 913                     }\r
 914                     if (newParent != null && newParent.addedByUses) {\r
 915                         newParent = findOriginal(newParent);\r
 916                     }
 917                     return newParent;
 918                 }
 919             }
 920
 921             return result;
 922         }
 923     }
 924
 925     /**\r
 926      * Convenient method to find node added by uses statement.\r
 927      */
 928     private def DataSchemaNode findOriginalTargetFromGrouping(String targetSchemaNodeName, UsesNode parentUsesNode) {
 929         var SchemaNode targetGrouping = findNodeInSchemaContext(schemaContext, parentUsesNode.groupingPath.path);
 930         if (!(targetGrouping instanceof GroupingDefinition)) {
 931             throw new IllegalArgumentException("Failed to generate code for augment in " + parentUsesNode);
 932         }
 933
 934         var grouping = targetGrouping as GroupingDefinition;
 935         var result = grouping.getDataChildByName(targetSchemaNodeName);
 936         if (result == null) {
 937             return null;
 938         }
 939         var boolean fromUses = result.addedByUses;
 940
 941         var Iterator<UsesNode> groupingUses = grouping.uses.iterator;
 942         while (fromUses) {
 943             if (groupingUses.hasNext()) {
 944                 grouping = findNodeInSchemaContext(schemaContext, groupingUses.next().groupingPath.path) as GroupingDefinition;
 945                 result = grouping.getDataChildByName(targetSchemaNodeName);
 946                 fromUses = result.addedByUses;
 947             } else {
 948                 throw new NullPointerException("Failed to generate code for augment in " + parentUsesNode);
 949             }
 950         }
 951
 952         return result;
 953     }
 954
 955     /**\r
 956      * Returns a generated type builder for an augmentation.\r
 957      *\r
 958      * The name of the type builder is equal to the name of augmented node with\r
 959      * serial number as suffix.\r
 960      *\r
 961      * @param module current module\r
 962      * @param augmentPackageName\r
 963      *            string with contains the package name to which the augment\r
 964      *            belongs\r
 965      * @param basePackageName\r
 966      *            string with the package name to which the augmented node\r
 967      *            belongs\r
 968      * @param targetTypeRef\r
 969      *            target type\r
 970      * @param augSchema\r
 971      *            augmentation schema which contains data about the child nodes\r
 972      *            and uses of augment\r
 973      * @return generated type builder for augment\r
 974      */
 975     private def GeneratedTypeBuilder addRawAugmentGenTypeDefinition(Module module, String augmentPackageName,
 976         String basePackageName, Type targetTypeRef, AugmentationSchema augSchema) {
 977         var Map<String, GeneratedTypeBuilder> augmentBuilders = genTypeBuilders.get(augmentPackageName);
 978         if (augmentBuilders === null) {
 979             augmentBuilders = new HashMap();
 980             genTypeBuilders.put(augmentPackageName, augmentBuilders);
 981         }
 982         val augIdentifier = getAugmentIdentifier(augSchema.unknownSchemaNodes);
 983
 984         val augTypeName = if (augIdentifier !== null) {
 985                 BindingMapping.getClassName(augIdentifier)
 986             } else {
 987                 augGenTypeName(augmentBuilders, targetTypeRef.name);
 988             }
 989
 990         val augTypeBuilder = new GeneratedTypeBuilderImpl(augmentPackageName, augTypeName);
 991
 992         augTypeBuilder.addImplementsType(DATA_OBJECT);
 993         augTypeBuilder.addImplementsType(Types.augmentationTypeFor(targetTypeRef));
 994         addImplementedInterfaceFromUses(augSchema, augTypeBuilder);
 995
 996         augSchemaNodeToMethods(module, basePackageName, augTypeBuilder, augTypeBuilder, augSchema.childNodes);
 997         augmentBuilders.put(augTypeName, augTypeBuilder);
 998         return augTypeBuilder;
 999     }
1000
1001     /**\r
1002      *\r
1003      * @param unknownSchemaNodes\r
1004      * @return nodeParameter of UnknownSchemaNode\r
1005      */
1006     private def String getAugmentIdentifier(List<UnknownSchemaNode> unknownSchemaNodes) {
1007         for (unknownSchemaNode : unknownSchemaNodes) {
1008             val nodeType = unknownSchemaNode.nodeType;
1009             if (AUGMENT_IDENTIFIER_NAME.equals(nodeType.localName) &&
1010                 YANG_EXT_NAMESPACE.equals(nodeType.namespace.toString())) {
1011                 return unknownSchemaNode.nodeParameter;
1012             }
1013         }
1014         return null;
1015     }
1016
1017     /**\r
1018      * Returns first unique name for the augment generated type builder. The\r
1019      * generated type builder name for augment consists from name of augmented\r
1020      * node and serial number of its augmentation.\r
1021      *\r
1022      * @param builders\r
1023      *            map of builders which were created in the package to which the\r
1024      *            augmentation belongs\r
1025      * @param genTypeName\r
1026      *            string with name of augmented node\r
1027      * @return string with unique name for augmentation builder\r
1028      */
1029     private def String augGenTypeName(Map<String, GeneratedTypeBuilder> builders, String genTypeName) {
1030         var index = 1;
1031         while ((builders !== null) && builders.containsKey(genTypeName + index)) {
1032             index = index + 1;
1033         }
1034         return genTypeName + index;
1035     }
1036
1037     /**\r
1038      * Adds the methods to <code>typeBuilder</code> which represent subnodes of\r
1039      * node for which <code>typeBuilder</code> was created.\r
1040      *\r
1041      * The subnodes aren't mapped to the methods if they are part of grouping or\r
1042      * augment (in this case are already part of them).\r
1043      *\r
1044      * @param module current module\r
1045      * @param basePackageName\r
1046      *            string contains the module package name\r
1047      * @param parent\r
1048      *            generated type builder which represents any node. The subnodes\r
1049      *            of this node are added to the <code>typeBuilder</code> as\r
1050      *            methods. The subnode can be of type leaf, leaf-list, list,\r
1051      *            container, choice.\r
1052      * @param childOf parent type\r
1053      * @param schemaNodes\r
1054      *            set of data schema nodes which are the children of the node\r
1055      *            for which <code>typeBuilder</code> was created\r
1056      * @return generated type builder which is the same builder as input\r
1057      *         parameter. The getter methods (representing child nodes) could be\r
1058      *         added to it.\r
1059      */
1060     private def GeneratedTypeBuilder resolveDataSchemaNodes(Module module, String basePackageName,
1061         GeneratedTypeBuilder parent, GeneratedTypeBuilder childOf, Set<DataSchemaNode> schemaNodes) {
1062         if ((schemaNodes !== null) && (parent !== null)) {
1063             for (schemaNode : schemaNodes) {
1064                 if (!schemaNode.augmenting && !schemaNode.addedByUses) {
1065                     addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, parent, childOf, module);
1066                 }
1067             }
1068         }
1069         return parent;
1070     }
1071
1072     /**\r
1073      * Adds the methods to <code>typeBuilder</code> what represents subnodes of\r
1074      * node for which <code>typeBuilder</code> was created.\r
1075      *\r
1076      * @param module current module\r
1077      * @param basePackageName\r
1078      *            string contains the module package name\r
1079      * @param typeBuilder\r
1080      *            generated type builder which represents any node. The subnodes\r
1081      *            of this node are added to the <code>typeBuilder</code> as\r
1082      *            methods. The subnode can be of type leaf, leaf-list, list,\r
1083      *            container, choice.\r
1084      * @param childOf parent type\r
1085      * @param schemaNodes\r
1086      *            set of data schema nodes which are the children of the node\r
1087      *            for which <code>typeBuilder</code> was created\r
1088      * @return generated type builder which is the same object as the input\r
1089      *         parameter <code>typeBuilder</code>. The getter method could be\r
1090      *         added to it.\r
1091      */
1092     private def GeneratedTypeBuilder augSchemaNodeToMethods(Module module, String basePackageName,
1093         GeneratedTypeBuilder typeBuilder, GeneratedTypeBuilder childOf, Set<DataSchemaNode> schemaNodes) {
1094         if ((schemaNodes !== null) && (typeBuilder !== null)) {
1095             for (schemaNode : schemaNodes) {
1096                 if (!schemaNode.isAugmenting()) {
1097                     addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder, childOf, module);
1098                 }
1099             }
1100         }
1101         return typeBuilder;
1102     }
1103
1104     /**\r
1105      * Adds to <code>typeBuilder</code> a method which is derived from\r
1106      * <code>schemaNode</code>.\r
1107      *\r
1108      * @param basePackageName\r
1109      *            string with the module package name\r
1110      * @param node\r
1111      *            data schema node which is added to <code>typeBuilder</code> as\r
1112      *            a method\r
1113      * @param typeBuilder\r
1114      *            generated type builder to which is <code>schemaNode</code>\r
1115      *            added as a method.\r
1116      * @param childOf parent type\r
1117      * @param module current module\r
1118      */
1119     private def void addSchemaNodeToBuilderAsMethod(String basePackageName, DataSchemaNode node,
1120         GeneratedTypeBuilder typeBuilder, GeneratedTypeBuilder childOf, Module module) {
1121         if (node !== null && typeBuilder !== null) {
1122             switch (node) {
1123                 case node instanceof LeafSchemaNode:
1124                     resolveLeafSchemaNodeAsMethod(typeBuilder, node as LeafSchemaNode)
1125                 case node instanceof LeafListSchemaNode:
1126                     resolveLeafListSchemaNode(typeBuilder, node as LeafListSchemaNode)
1127                 case node instanceof ContainerSchemaNode:
1128                     containerToGenType(module, basePackageName, typeBuilder, childOf, node as ContainerSchemaNode)
1129                 case node instanceof ListSchemaNode:
1130                     listToGenType(module, basePackageName, typeBuilder, childOf, node as ListSchemaNode)
1131                 case node instanceof ChoiceNode:
1132                     choiceToGeneratedType(module, basePackageName, typeBuilder, node as ChoiceNode)
1133             }
1134         }
1135     }
1136
1137     /**\r
1138      * Converts <code>choiceNode</code> to the list of generated types for\r
1139      * choice and its cases.\r
1140      *\r
1141      * The package names for choice and for its cases are created as\r
1142      * concatenation of the module package (<code>basePackageName</code>) and\r
1143      * names of all parents node.\r
1144      *\r
1145      * @param module current module\r
1146      * @param basePackageName\r
1147      *            string with the module package name\r
1148      * @param parent parent type\r
1149      * @param childOf concrete parent for case child nodes\r
1150      * @param choiceNode\r
1151      *            choice node which is mapped to generated type. Also child\r
1152      *            nodes - cases are mapped to generated types.\r
1153      * @throws IllegalArgumentException\r
1154      *             <ul>\r
1155      *             <li>if <code>basePackageName</code> equals null</li>\r
1156      *             <li>if <code>choiceNode</code> equals null</li>\r
1157      *             </ul>\r
1158      *\r
1159      */
1160     private def void choiceToGeneratedType(Module module, String basePackageName, GeneratedTypeBuilder parent,
1161         ChoiceNode choiceNode) {
1162         checkArgument(basePackageName !== null, "Base Package Name cannot be NULL.");
1163         checkArgument(choiceNode !== null, "Choice Schema Node cannot be NULL.");
1164
1165         if (!choiceNode.addedByUses) {
1166             val packageName = packageNameForGeneratedType(basePackageName, choiceNode.path);
1167             val choiceTypeBuilder = addRawInterfaceDefinition(packageName, choiceNode);
1168             constructGetter(parent, choiceNode.QName.localName, choiceNode.description, choiceTypeBuilder);
1169             choiceTypeBuilder.addImplementsType(DataContainer.typeForClass);
1170             genCtx.get(module).addChildNodeType(choiceNode.path, choiceTypeBuilder)
1171             generateTypesFromChoiceCases(module, basePackageName, parent, choiceTypeBuilder.toInstance, choiceNode);
1172         }
1173     }
1174
1175     /**\r
1176      * Converts <code>caseNodes</code> set to list of corresponding generated\r
1177      * types.\r
1178      *\r
1179      * For every <i>case</i> which isn't added through augment or <i>uses</i> is\r
1180      * created generated type builder. The package names for the builder is\r
1181      * created as concatenation of the module package (\r
1182      * <code>basePackageName</code>) and names of all parents nodes of the\r
1183      * concrete <i>case</i>. There is also relation "<i>implements type</i>"\r
1184      * between every case builder and <i>choice</i> type\r
1185      *\r
1186      * @param basePackageName\r
1187      *            string with the module package name\r
1188      * @param refChoiceType\r
1189      *            type which represents superior <i>case</i>\r
1190      * @param caseNodes\r
1191      *            set of choice case nodes which are mapped to generated types\r
1192      * @return list of generated types for <code>caseNodes</code>.\r
1193      * @throws IllegalArgumentException\r
1194      *             <ul>\r
1195      *             <li>if <code>basePackageName</code> equals null</li>\r
1196      *             <li>if <code>refChoiceType</code> equals null</li>\r
1197      *             <li>if <code>caseNodes</code> equals null</li>\r
1198      *             </ul>\r
1199      *             *\r
1200      */
1201     private def void generateTypesFromChoiceCases(Module module, String basePackageName,
1202         GeneratedTypeBuilder choiceParent, Type refChoiceType, ChoiceNode choiceNode) {
1203         checkArgument(basePackageName !== null, "Base Package Name cannot be NULL.");
1204         checkArgument(refChoiceType !== null, "Referenced Choice Type cannot be NULL.");
1205         checkArgument(choiceNode !== null, "ChoiceNode cannot be NULL.");
1206
1207         val Set<ChoiceCaseNode> caseNodes = choiceNode.cases;
1208         if (caseNodes == null) {
1209             return
1210         }
1211
1212         for (caseNode : caseNodes) {
1213             if (caseNode !== null && !caseNode.isAddedByUses() && !caseNode.isAugmenting()) {
1214                 val packageName = packageNameForGeneratedType(basePackageName, caseNode.path)
1215                 val caseTypeBuilder = addDefaultInterfaceDefinition(packageName, caseNode)
1216                 caseTypeBuilder.addImplementsType(refChoiceType)
1217                 genCtx.get(module).addCaseType(caseNode.path, caseTypeBuilder)
1218                 val Set<DataSchemaNode> caseChildNodes = caseNode.childNodes
1219                 if (caseChildNodes !== null) {
1220                     val parentNode = choiceNode.parent
1221                     var SchemaNode parent
1222                     if (parentNode instanceof AugmentationSchema) {
1223                         val augSchema = parentNode as AugmentationSchema;
1224                         val targetPath = augSchema.targetPath;
1225                         var targetSchemaNode = findDataSchemaNode(schemaContext, targetPath)
1226                         if (targetSchemaNode instanceof DataSchemaNode &&
1227                             (targetSchemaNode as DataSchemaNode).isAddedByUses()) {
1228                             targetSchemaNode = findOriginal(targetSchemaNode as DataSchemaNode);
1229                             if (targetSchemaNode == null) {
1230                                 throw new NullPointerException(
1231                                     "Failed to find target node from grouping for augmentation " + augSchema +
1232                                         " in module " + module.name);
1233                             }
1234                         }
1235                         parent = targetSchemaNode
1236                     } else {
1237                         parent = choiceNode.parent as SchemaNode
1238                     }
1239                     var GeneratedTypeBuilder childOfType = findChildNodeByPath(parent.path)
1240                     resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, childOfType, caseChildNodes)
1241                 }
1242             }
1243
1244             processUsesAugments(caseNode, module);
1245         }
1246     }
1247
1248     /**\r
1249      * Generates list of generated types for all the cases of a choice which are\r
1250      * added to the choice through the augment.\r
1251      *\r
1252      *\r
1253      * @param basePackageName\r
1254      *            string contains name of package to which augment belongs. If\r
1255      *            an augmented choice is from an other package (pcg1) than an\r
1256      *            augmenting choice (pcg2) then case's of the augmenting choice\r
1257      *            will belong to pcg2.\r
1258      * @param refChoiceType\r
1259      *            Type which represents the choice to which case belongs. Every\r
1260      *            case has to contain its choice in extend part.\r
1261      * @param caseNodes\r
1262      *            set of choice case nodes for which is checked if are/aren't\r
1263      *            added to choice through augmentation\r
1264      * @return list of generated types which represents augmented cases of\r
1265      *         choice <code>refChoiceType</code>\r
1266      * @throws IllegalArgumentException\r
1267      *             <ul>\r
1268      *             <li>if <code>basePackageName</code> equals null</li>\r
1269      *             <li>if <code>refChoiceType</code> equals null</li>\r
1270      *             <li>if <code>caseNodes</code> equals null</li>\r
1271      *             </ul>\r
1272      */
1273     private def void generateTypesFromAugmentedChoiceCases(Module module, String basePackageName, Type targetType,
1274         ChoiceNode targetNode, Set<DataSchemaNode> augmentedNodes) {
1275         checkArgument(basePackageName !== null, "Base Package Name cannot be NULL.");
1276         checkArgument(targetType !== null, "Referenced Choice Type cannot be NULL.");
1277         checkArgument(augmentedNodes !== null, "Set of Choice Case Nodes cannot be NULL.");
1278
1279         for (caseNode : augmentedNodes) {
1280             if (caseNode !== null) {
1281                 val packageName = packageNameForGeneratedType(basePackageName, caseNode.path);
1282                 val caseTypeBuilder = addDefaultInterfaceDefinition(packageName, caseNode);
1283                 caseTypeBuilder.addImplementsType(targetType);
1284
1285                 val SchemaNode parent = targetNode.parent as SchemaNode;
1286                 var GeneratedTypeBuilder childOfType = null;
1287                 if (parent instanceof Module) {
1288                     childOfType = genCtx.get(parent as Module).moduleNode
1289                 } else if (parent instanceof ChoiceCaseNode) {
1290                     childOfType = findCaseByPath(parent.path)
1291                 } else if (parent instanceof DataSchemaNode || parent instanceof NotificationDefinition) {
1292                     childOfType = findChildNodeByPath(parent.path)
1293                 } else if (parent instanceof GroupingDefinition) {
1294                     childOfType = findGroupingByPath(parent.path);
1295                 }
1296
1297                 if (childOfType == null) {
1298                     throw new IllegalArgumentException("Failed to find parent type of choice " + targetNode);
1299                 }
1300
1301                 if (caseNode instanceof DataNodeContainer) {
1302                     val DataNodeContainer dataNodeCase = caseNode as DataNodeContainer;
1303                     val Set<DataSchemaNode> childNodes = dataNodeCase.childNodes;
1304                     if (childNodes !== null) {
1305                         resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, childOfType, childNodes);
1306                     }
1307                 } else {
1308                     val ChoiceCaseNode node = targetNode.getCaseNodeByName(caseNode.getQName().getLocalName());
1309                     val Set<DataSchemaNode> childNodes = node.childNodes;
1310                     if (childNodes !== null) {
1311                         resolveDataSchemaNodes(module, basePackageName, caseTypeBuilder, childOfType, childNodes);
1312                     }
1313                 }
1314
1315                 genCtx.get(module).addCaseType(caseNode.path, caseTypeBuilder)
1316             }
1317         }
1318
1319     }
1320
1321     /**\r
1322      * Converts <code>leaf</code> to the getter method which is added to\r
1323      * <code>typeBuilder</code>.\r
1324      *\r
1325      * @param typeBuilder\r
1326      *            generated type builder to which is added getter method as\r
1327      *            <code>leaf</code> mapping\r
1328      * @param leaf\r
1329      *            leaf schema node which is mapped as getter method which is\r
1330      *            added to <code>typeBuilder</code>\r
1331      * @return boolean value\r
1332      *         <ul>\r
1333      *         <li>false - if <code>leaf</code> or <code>typeBuilder</code> are\r
1334      *         null</li>\r
1335      *         <li>true - in other cases</li>\r
1336      *         </ul>\r
1337      */
1338     private def boolean resolveLeafSchemaNodeAsMethod(GeneratedTypeBuilder typeBuilder, LeafSchemaNode leaf) {
1339         if ((leaf !== null) && (typeBuilder !== null)) {
1340             val leafName = leaf.QName.localName;
1341             var String leafDesc = leaf.description;
1342             if (leafDesc === null) {
1343                 leafDesc = "";
1344             }
1345
1346             val parentModule = findParentModule(schemaContext, leaf);
1347             if (leafName !== null && !leaf.isAddedByUses()) {
1348                 val TypeDefinition<?> typeDef = leaf.type;
1349
1350                 var Type returnType = null;
1351                 var GeneratedTOBuilder genTOBuilder;
1352                 if (typeDef instanceof EnumTypeDefinition) {
1353                     returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
1354                     val enumTypeDef = typeDef as EnumTypeDefinition;
1355                     val enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, leaf.QName, typeBuilder);
1356
1357                     if (enumBuilder !== null) {
1358                         returnType = new ReferencedTypeImpl(enumBuilder.packageName, enumBuilder.name);
1359                     }
1360                     (typeProvider as TypeProviderImpl).putReferencedType(leaf.path, returnType);
1361                 } else if (typeDef instanceof UnionType) {
1362                     genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule);\r
1363                     if (genTOBuilder !== null) {\r
1364                         returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule)\r
1365                     }
1366                 } else if (typeDef instanceof BitsTypeDefinition) {
1367                     genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leaf, parentModule);\r
1368                     if (genTOBuilder !== null) {\r
1369                         returnType = new ReferencedTypeImpl(genTOBuilder.packageName, genTOBuilder.name);\r
1370                     }
1371                 } else {
1372                     val Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);
1373                     returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf, restrictions);
1374                 }
1375                 if (returnType !== null) {
1376                     val MethodSignatureBuilder getter = constructGetter(typeBuilder, leafName, leafDesc, returnType);
1377                     processContextRefExtension(leaf, getter, parentModule);
1378                     return true;
1379                 }
1380             }
1381         }
1382         return false;
1383     }
1384
1385     private def void processContextRefExtension(LeafSchemaNode leaf, MethodSignatureBuilder getter, Module module) {
1386         for (node : leaf.unknownSchemaNodes) {
1387             val nodeType = node.nodeType;
1388             if ("context-reference".equals(nodeType.localName)) {
1389                 val nodeParam = node.nodeParameter;
1390                 var IdentitySchemaNode identity = null;
1391                 var String basePackageName = null;
1392                 val String[] splittedElement = nodeParam.split(":");
1393                 if (splittedElement.length == 1) {
1394                     identity = findIdentityByName(module.identities, splittedElement.get(0));
1395                     basePackageName = moduleNamespaceToPackageName(module);
1396                 } else if (splittedElement.length == 2) {
1397                     var prefix = splittedElement.get(0);
1398                     val Module dependentModule = findModuleFromImports(module.imports, prefix)
1399                     if (dependentModule == null) {
1400                         throw new IllegalArgumentException(
1401                             "Failed to process context-reference: unknown prefix " + prefix);
1402                     }
1403                     identity = findIdentityByName(dependentModule.identities, splittedElement.get(1));
1404                     basePackageName = moduleNamespaceToPackageName(dependentModule);
1405                 } else {
1406                     throw new IllegalArgumentException(
1407                         "Failed to process context-reference: unknown identity " + nodeParam);
1408                 }
1409                 if (identity == null) {
1410                     throw new IllegalArgumentException(
1411                         "Failed to process context-reference: unknown identity " + nodeParam);
1412                 }
1413
1414                 val Class<RoutingContext> clazz = typeof(RoutingContext);
1415                 val AnnotationTypeBuilder rc = getter.addAnnotation(clazz.package.name, clazz.simpleName);
1416                 val packageName = packageNameForGeneratedType(basePackageName, identity.path);
1417                 val genTypeName = BindingMapping.getClassName(identity.QName.localName);
1418                 rc.addParameter("value", packageName + "." + genTypeName + ".class");
1419             }
1420         }
1421     }
1422
1423     private def IdentitySchemaNode findIdentityByName(Set<IdentitySchemaNode> identities, String name) {
1424         for (id : identities) {
1425             if (id.QName.localName.equals(name)) {
1426                 return id;
1427             }
1428         }
1429         return null;
1430     }
1431
1432     private def Module findModuleFromImports(Set<ModuleImport> imports, String prefix) {
1433         for (imp : imports) {
1434             if (imp.prefix.equals(prefix)) {
1435                 return schemaContext.findModuleByName(imp.moduleName, imp.revision);
1436             }
1437         }
1438         return null;
1439     }
1440
1441     /**\r
1442      * Converts <code>leaf</code> schema node to property of generated TO\r
1443      * builder.\r
1444      *\r
1445      * @param toBuilder\r
1446      *            generated TO builder to which is <code>leaf</code> added as\r
1447      *            property\r
1448      * @param leaf\r
1449      *            leaf schema node which is added to <code>toBuilder</code> as\r
1450      *            property\r
1451      * @param isReadOnly\r
1452      *            boolean value which says if leaf property is|isn't read only\r
1453      * @return boolean value\r
1454      *         <ul>\r
1455      *         <li>false - if <code>leaf</code>, <code>toBuilder</code> or leaf\r
1456      *         name equals null or if leaf is added by <i>uses</i>.</li>\r
1457      *         <li>true - other cases</li>\r
1458      *         </ul>\r
1459      */
1460     private def boolean resolveLeafSchemaNodeAsProperty(GeneratedTOBuilder toBuilder, LeafSchemaNode leaf,
1461         boolean isReadOnly) {
1462         if ((leaf !== null) && (toBuilder !== null)) {
1463             val leafName = leaf.QName.localName;
1464             var String leafDesc = leaf.description;
1465             if (leafDesc === null) {
1466                 leafDesc = "";
1467             }
1468
1469             if (leafName !== null) {
1470                 val TypeDefinition<?> typeDef = leaf.type;
1471
1472                 // TODO: properly resolve enum types\r
1473                 val returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
1474                 if (returnType !== null) {
1475                     val propBuilder = toBuilder.addProperty(parseToValidParamName(leafName));
1476                     propBuilder.setReadOnly(isReadOnly);
1477                     propBuilder.setReturnType(returnType);
1478                     propBuilder.setComment(leafDesc);
1479                     toBuilder.addEqualsIdentity(propBuilder);
1480                     toBuilder.addHashIdentity(propBuilder);
1481                     toBuilder.addToStringProperty(propBuilder);
1482                     return true;
1483                 }
1484             }
1485         }
1486         return false;
1487     }
1488
1489     /**\r
1490      * Converts <code>node</code> leaf list schema node to getter method of\r
1491      * <code>typeBuilder</code>.\r
1492      *\r
1493      * @param typeBuilder\r
1494      *            generated type builder to which is <code>node</code> added as\r
1495      *            getter method\r
1496      * @param node\r
1497      *            leaf list schema node which is added to\r
1498      *            <code>typeBuilder</code> as getter method\r
1499      * @return boolean value\r
1500      *         <ul>\r
1501      *         <li>true - if <code>node</code>, <code>typeBuilder</code>,\r
1502      *         nodeName equal null or <code>node</code> is added by <i>uses</i></li>\r
1503      *         <li>false - other cases</li>\r
1504      *         </ul>\r
1505      */
1506     private def boolean resolveLeafListSchemaNode(GeneratedTypeBuilder typeBuilder, LeafListSchemaNode node) {
1507         if ((node !== null) && (typeBuilder !== null)) {
1508             val nodeName = node.QName;
1509             var String nodeDesc = node.description;
1510             if (nodeDesc === null) {
1511                 nodeDesc = "";
1512             }
1513             if (nodeName !== null && !node.isAddedByUses()) {
1514                 val TypeDefinition<?> typeDef = node.type;\r
1515                 val parentModule = findParentModule(schemaContext, node);\r
1516 \r
1517                 var Type returnType = null;\r
1518                 if (typeDef instanceof EnumTypeDefinition) {\r
1519                     returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node);\r
1520                     val enumTypeDef = typeDef as EnumTypeDefinition;\r
1521                     val enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, nodeName, typeBuilder);\r
1522                     returnType = new ReferencedTypeImpl(enumBuilder.packageName, enumBuilder.name);\r
1523                     (typeProvider as TypeProviderImpl).putReferencedType(node.path, returnType);\r
1524                 } else if (typeDef instanceof UnionType) {\r
1525                     val genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule);\r
1526                     if (genTOBuilder !== null) {\r
1527                         returnType = createReturnTypeForUnion(genTOBuilder, typeDef, typeBuilder, parentModule)\r
1528                     }
1529                 } else if (typeDef instanceof BitsTypeDefinition) {\r
1530                     val genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, node, parentModule);\r
1531                     returnType = new ReferencedTypeImpl(genTOBuilder.packageName, genTOBuilder.name);\r
1532                 } else {\r
1533                     val Restrictions restrictions = BindingGeneratorUtil.getRestrictions(typeDef);\r
1534                     returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, node, restrictions);\r
1535                 }\r
1536
1537                 val listType = Types.listTypeFor(returnType);
1538                 constructGetter(typeBuilder, nodeName.localName, nodeDesc, listType);
1539                 return true;
1540             }
1541         }
1542         return false;
1543     }
1544 \r
1545     private def Type createReturnTypeForUnion(GeneratedTOBuilder genTOBuilder, TypeDefinition<?> typeDef,
1546         GeneratedTypeBuilder typeBuilder, Module parentModule) {
1547         val Type returnType = new ReferencedTypeImpl(genTOBuilder.packageName, genTOBuilder.name);
1548         genTOBuilder.setTypedef(true);
1549         genTOBuilder.setIsUnion(true);
1550         (typeProvider as TypeProviderImpl).addUnitsToGenTO(genTOBuilder, typeDef.getUnits());
1551
1552         // union builder\r
1553         val GeneratedTOBuilder unionBuilder = new GeneratedTOBuilderImpl(typeBuilder.getPackageName(),
1554             genTOBuilder.getName() + "Builder");
1555         unionBuilder.setIsUnionBuilder(true);
1556         val MethodSignatureBuilder method = unionBuilder.addMethod("getDefaultInstance");
1557         method.setReturnType(returnType);
1558         method.addParameter(Types.STRING, "defaultValue");
1559         method.setAccessModifier(AccessModifier.PUBLIC);
1560         method.setStatic(true);
1561
1562         val Set<Type> types = (typeProvider as TypeProviderImpl).additionalTypes.get(parentModule);
1563         if (types == null) {
1564             (typeProvider as TypeProviderImpl).additionalTypes.put(parentModule,
1565                 Sets.newHashSet(unionBuilder.toInstance))
1566         } else {
1567             types.add(unionBuilder.toInstance)
1568         }
1569         return returnType
1570     }\r
1571
1572     private def GeneratedTypeBuilder addDefaultInterfaceDefinition(String packageName, SchemaNode schemaNode) {
1573         return addDefaultInterfaceDefinition(packageName, schemaNode, null);
1574     }
1575
1576     /**\r
1577      * Instantiates generated type builder with <code>packageName</code> and\r
1578      * <code>schemaNode</code>.\r
1579      *\r
1580      * The new builder always implements\r
1581      * {@link org.opendaylight.yangtools.yang.binding.DataObject DataObject}.<br />\r
1582      * If <code>schemaNode</code> is instance of GroupingDefinition it also\r
1583      * implements {@link org.opendaylight.yangtools.yang.binding.Augmentable\r
1584      * Augmentable}.<br />\r
1585      * If <code>schemaNode</code> is instance of\r
1586      * {@link org.opendaylight.yangtools.yang.model.api.DataNodeContainer\r
1587      * DataNodeContainer} it can also implement nodes which are specified in\r
1588      * <i>uses</i>.\r
1589      *\r
1590      * @param packageName\r
1591      *            string with the name of the package to which\r
1592      *            <code>schemaNode</code> belongs.\r
1593      * @param schemaNode\r
1594      *            schema node for which is created generated type builder\r
1595      * @param parent parent type (can be null)\r
1596      * @return generated type builder <code>schemaNode</code>\r
1597      */
1598     private def GeneratedTypeBuilder addDefaultInterfaceDefinition(String packageName, SchemaNode schemaNode,
1599         Type parent) {
1600         val it = addRawInterfaceDefinition(packageName, schemaNode, "");\r
1601         val qname = schemaNode.QName;
1602         qnameConstant(BindingMapping.QNAME_STATIC_FIELD_NAME,schemaNode.QName);\r
1603         if (parent === null) {
1604             addImplementsType(DATA_OBJECT);
1605         } else {
1606             addImplementsType(BindingTypes.childOf(parent));
1607         }
1608         if (!(schemaNode instanceof GroupingDefinition)) {
1609             addImplementsType(augmentable(it));
1610         }
1611
1612         if (schemaNode instanceof DataNodeContainer) {
1613             addImplementedInterfaceFromUses(schemaNode as DataNodeContainer, it);
1614         }
1615
1616         return it;
1617     }
1618
1619     /**\r
1620      * Wraps the calling of the same overloaded method.\r
1621      *\r
1622      * @param packageName\r
1623      *            string with the package name to which returning generated type\r
1624      *            builder belongs\r
1625      * @param schemaNode\r
1626      *            schema node which provide data about the schema node name\r
1627      * @return generated type builder for <code>schemaNode</code>\r
1628      */
1629     private def GeneratedTypeBuilder addRawInterfaceDefinition(String packageName, SchemaNode schemaNode) {
1630         return addRawInterfaceDefinition(packageName, schemaNode, "");
1631     }
1632
1633     /**\r
1634      * Returns reference to generated type builder for specified\r
1635      * <code>schemaNode</code> with <code>packageName</code>.\r
1636      *\r
1637      * Firstly the generated type builder is searched in\r
1638      * {@link BindingGeneratorImpl#genTypeBuilders genTypeBuilders}. If it isn't\r
1639      * found it is created and added to <code>genTypeBuilders</code>.\r
1640      *\r
1641      * @param packageName\r
1642      *            string with the package name to which returning generated type\r
1643      *            builder belongs\r
1644      * @param schemaNode\r
1645      *            schema node which provide data about the schema node name\r
1646      * @param prefix return type name prefix\r
1647      * @return generated type builder for <code>schemaNode</code>\r
1648      * @throws IllegalArgumentException\r
1649      *             <ul>\r
1650      *             <li>if <code>schemaNode</code> equals null</li>\r
1651      *             <li>if <code>packageName</code> equals null</li>\r
1652      *             <li>if Q name of schema node is null</li>\r
1653      *             <li>if schema node name is nul</li>\r
1654      *             </ul>\r
1655      *\r
1656      */
1657     private def GeneratedTypeBuilder addRawInterfaceDefinition(String packageName, SchemaNode schemaNode,
1658         String prefix) {
1659         checkArgument(schemaNode !== null, "Data Schema Node cannot be NULL.");
1660         checkArgument(packageName !== null, "Package Name for Generated Type cannot be NULL.");
1661         checkArgument(schemaNode.QName !== null, "QName for Data Schema Node cannot be NULL.");
1662         val schemaNodeName = schemaNode.QName.localName;
1663         checkArgument(schemaNodeName !== null, "Local Name of QName for Data Schema Node cannot be NULL.");
1664
1665         var String genTypeName;
1666         if (prefix === null) {
1667             genTypeName = BindingMapping.getClassName(schemaNodeName);
1668         } else {
1669             genTypeName = prefix + BindingMapping.getClassName(schemaNodeName);
1670         }
1671
1672         //FIXME: Validation of name conflict\r
1673         val newType = new GeneratedTypeBuilderImpl(packageName, genTypeName);
1674         if (!genTypeBuilders.containsKey(packageName)) {
1675             val Map<String, GeneratedTypeBuilder> builders = new HashMap();
1676             builders.put(genTypeName, newType);
1677             genTypeBuilders.put(packageName, builders);
1678         } else {
1679             val Map<String, GeneratedTypeBuilder> builders = genTypeBuilders.get(packageName);
1680             if (!builders.containsKey(genTypeName)) {
1681                 builders.put(genTypeName, newType);
1682             }
1683         }
1684         return newType;
1685     }
1686
1687     /**\r
1688      * Creates the name of the getter method from <code>localName</code>.\r
1689      *\r
1690      * @param localName\r
1691      *            string with the name of the getter method\r
1692      * @param returnType return type\r
1693      * @return string with the name of the getter method for\r
1694      *         <code>localName</code> in JAVA method format\r
1695      */
1696     public static def String getterMethodName(String localName, Type returnType) {
1697         val method = new StringBuilder();
1698         if (BOOLEAN.equals(returnType)) {
1699             method.append("is");
1700         } else {
1701             method.append("get");
1702         }
1703         method.append(BindingMapping.getClassName(localName));
1704         return method.toString();
1705     }
1706
1707     /**\r
1708      * Created a method signature builder as part of\r
1709      * <code>interfaceBuilder</code>.\r
1710      *\r
1711      * The method signature builder is created for the getter method of\r
1712      * <code>schemaNodeName</code>. Also <code>comment</code> and\r
1713      * <code>returnType</code> information are added to the builder.\r
1714      *\r
1715      * @param interfaceBuilder\r
1716      *            generated type builder for which the getter method should be\r
1717      *            created\r
1718      * @param schemaNodeName\r
1719      *            string with schema node name. The name will be the part of the\r
1720      *            getter method name.\r
1721      * @param comment\r
1722      *            string with comment for the getter method\r
1723      * @param returnType\r
1724      *            type which represents the return type of the getter method\r
1725      * @return method signature builder which represents the getter method of\r
1726      *         <code>interfaceBuilder</code>\r
1727      */
1728     private def MethodSignatureBuilder constructGetter(GeneratedTypeBuilder interfaceBuilder, String schemaNodeName,
1729         String comment, Type returnType) {
1730         val getMethod = interfaceBuilder.addMethod(getterMethodName(schemaNodeName, returnType));
1731         getMethod.setComment(comment);
1732         getMethod.setReturnType(returnType);
1733         return getMethod;
1734     }
1735
1736     /**\r
1737      * Adds <code>schemaNode</code> to <code>typeBuilder</code> as getter method\r
1738      * or to <code>genTOBuilder</code> as property.\r
1739      *\r
1740      * @param basePackageName\r
1741      *            string contains the module package name\r
1742      * @param schemaNode\r
1743      *            data schema node which should be added as getter method to\r
1744      *            <code>typeBuilder</code> or as a property to\r
1745      *            <code>genTOBuilder</code> if is part of the list key\r
1746      * @param typeBuilder\r
1747      *            generated type builder for the list schema node\r
1748      * @param genTOBuilder\r
1749      *            generated TO builder for the list keys\r
1750      * @param listKeys\r
1751      *            list of string which contains names of the list keys\r
1752      * @param module current module\r
1753      * @throws IllegalArgumentException\r
1754      *             <ul>\r
1755      *             <li>if <code>schemaNode</code> equals null</li>\r
1756      *             <li>if <code>typeBuilder</code> equals null</li>\r
1757      *             </ul>\r
1758      */
1759     private def void addSchemaNodeToListBuilders(String basePackageName, DataSchemaNode schemaNode,
1760         GeneratedTypeBuilder typeBuilder, GeneratedTOBuilder genTOBuilder, List<String> listKeys, Module module) {
1761         checkArgument(schemaNode !== null, "Data Schema Node cannot be NULL.");
1762         checkArgument(typeBuilder !== null, "Generated Type Builder cannot be NULL.");
1763
1764         if (schemaNode instanceof LeafSchemaNode) {
1765             val leaf = schemaNode as LeafSchemaNode;
1766             val leafName = leaf.QName.localName;\r
1767             resolveLeafSchemaNodeAsMethod(typeBuilder, leaf);
1768             if (listKeys.contains(leafName)) {
1769                 resolveLeafSchemaNodeAsProperty(genTOBuilder, leaf, true);
1770             }
1771         } else if (!schemaNode.addedByUses) {
1772             if (schemaNode instanceof LeafListSchemaNode) {
1773                 resolveLeafListSchemaNode(typeBuilder, schemaNode as LeafListSchemaNode);
1774             } else if (schemaNode instanceof ContainerSchemaNode) {
1775                 containerToGenType(module, basePackageName, typeBuilder, typeBuilder, schemaNode as ContainerSchemaNode);
1776             } else if (schemaNode instanceof ChoiceNode) {
1777                 choiceToGeneratedType(module, basePackageName, typeBuilder, schemaNode as ChoiceNode);
1778             } else if (schemaNode instanceof ListSchemaNode) {
1779                 listToGenType(module, basePackageName, typeBuilder, typeBuilder, schemaNode as ListSchemaNode);
1780             }
1781         }
1782     }
1783
1784     private def typeBuildersToGenTypes(Module module, GeneratedTypeBuilder typeBuilder, GeneratedTOBuilder genTOBuilder) {
1785         checkArgument(typeBuilder !== null, "Generated Type Builder cannot be NULL.");
1786
1787         if (genTOBuilder !== null) {
1788             val genTO = genTOBuilder.toInstance();
1789             constructGetter(typeBuilder, "key", "Returns Primary Key of Yang List Type", genTO);
1790             genCtx.get(module).addGeneratedTOBuilder(genTOBuilder)
1791         }
1792     }
1793
1794     /**\r
1795      * Selects the names of the list keys from <code>list</code> and returns\r
1796      * them as the list of the strings\r
1797      *\r
1798      * @param list\r
1799      *            of string with names of the list keys\r
1800      * @return list of string which represents names of the list keys. If the\r
1801      *         <code>list</code> contains no keys then the empty list is\r
1802      *         returned.\r
1803      */
1804     private def listKeys(ListSchemaNode list) {
1805         val List<String> listKeys = new ArrayList();
1806
1807         if (list.keyDefinition !== null) {
1808             val keyDefinitions = list.keyDefinition;
1809             for (keyDefinition : keyDefinitions) {
1810                 listKeys.add(keyDefinition.localName);
1811             }
1812         }
1813         return listKeys;
1814     }
1815
1816     /**\r
1817      * Generates for the <code>list</code> which contains any list keys special\r
1818      * generated TO builder.\r
1819      *\r
1820      * @param packageName\r
1821      *            string with package name to which the list belongs\r
1822      * @param list\r
1823      *            list schema node which is source of data about the list name\r
1824      * @return generated TO builder which represents the keys of the\r
1825      *         <code>list</code> or null if <code>list</code> is null or list of\r
1826      *         key definitions is null or empty.\r
1827      */
1828     private def GeneratedTOBuilder resolveListKeyTOBuilder(String packageName, ListSchemaNode list) {
1829         var GeneratedTOBuilder genTOBuilder = null;
1830         if ((list.keyDefinition !== null) && (!list.keyDefinition.isEmpty())) {
1831             val listName = list.QName.localName + "Key";
1832             val String genTOName = BindingMapping.getClassName(listName);
1833             genTOBuilder = new GeneratedTOBuilderImpl(packageName, genTOName);
1834         }
1835         return genTOBuilder;
1836     }
1837
1838     /**\r
1839      * Builds generated TO builders for <code>typeDef</code> of type\r
1840      * {@link org.opendaylight.yangtools.yang.model.util.UnionType UnionType} or\r
1841      * {@link org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition\r
1842      * BitsTypeDefinition} which are also added to <code>typeBuilder</code> as\r
1843      * enclosing transfer object.\r
1844      *\r
1845      * If more then one generated TO builder is created for enclosing then all\r
1846      * of the generated TO builders are added to <code>typeBuilder</code> as\r
1847      * enclosing transfer objects.\r
1848      *\r
1849      * @param typeDef\r
1850      *            type definition which can be of type <code>UnionType</code> or\r
1851      *            <code>BitsTypeDefinition</code>\r
1852      * @param typeBuilder\r
1853      *            generated type builder to which is added generated TO created\r
1854      *            from <code>typeDef</code>\r
1855      * @param leafName\r
1856      *            string with name for generated TO builder\r
1857      * @param leaf\r
1858      * @param parentModule\r
1859      * @return generated TO builder for <code>typeDef</code>\r
1860      */
1861     private def GeneratedTOBuilder addTOToTypeBuilder(TypeDefinition<?> typeDef, GeneratedTypeBuilder typeBuilder,
1862         DataSchemaNode leaf, Module parentModule) {
1863         val classNameFromLeaf = BindingMapping.getClassName(leaf.QName);
1864         val List<GeneratedTOBuilder> genTOBuilders = new ArrayList();
1865         val packageName = typeBuilder.fullyQualifiedName;
1866         if (typeDef instanceof UnionTypeDefinition) {\r
1867             val List<GeneratedTOBuilder> types = (typeProvider as TypeProviderImpl).\r
1868                     provideGeneratedTOBuildersForUnionTypeDef(packageName, (typeDef as UnionTypeDefinition),\r
1869                         classNameFromLeaf, leaf);
1870             genTOBuilders.addAll(types);\r
1871                         \r
1872             \r
1873         var GeneratedTOBuilder resultTOBuilder = null;\r
1874         if (!types.isEmpty()) {\r
1875             resultTOBuilder = types.remove(0);\r
1876             for (GeneratedTOBuilder genTOBuilder : types) {\r
1877                 resultTOBuilder.addEnclosingTransferObject(genTOBuilder);\r
1878             }\r
1879         }\r
1880 \r
1881         val GeneratedPropertyBuilder genPropBuilder = resultTOBuilder.addProperty("value");\r
1882         genPropBuilder.setReturnType(Types.primitiveType("char[]", null));\r
1883         resultTOBuilder.addEqualsIdentity(genPropBuilder);\r
1884         resultTOBuilder.addHashIdentity(genPropBuilder);\r
1885         resultTOBuilder.addToStringProperty(genPropBuilder);\r
1886
1887         } else if (typeDef instanceof BitsTypeDefinition) {
1888             genTOBuilders.add(
1889                 ((typeProvider as TypeProviderImpl) ).
1890                     provideGeneratedTOBuilderForBitsTypeDefinition(packageName, typeDef, classNameFromLeaf));
1891         }
1892         if (genTOBuilders !== null && !genTOBuilders.isEmpty()) {
1893             for (genTOBuilder : genTOBuilders) {
1894                 typeBuilder.addEnclosingTransferObject(genTOBuilder);
1895             }
1896             return genTOBuilders.get(0);
1897         }
1898         return null;
1899
1900     }
1901
1902     /**\r
1903      * Adds the implemented types to type builder.\r
1904      *\r
1905      * The method passes through the list of <i>uses</i> in\r
1906      * {@code dataNodeContainer}. For every <i>use</i> is obtained coresponding\r
1907      * generated type from {@link BindingGeneratorImpl#allGroupings\r
1908      * allGroupings} which is added as <i>implements type</i> to\r
1909      * <code>builder</code>\r
1910      *\r
1911      * @param dataNodeContainer\r
1912      *            element which contains the list of used YANG groupings\r
1913      * @param builder\r
1914      *            builder to which are added implemented types according to\r
1915      *            <code>dataNodeContainer</code>\r
1916      * @return generated type builder with all implemented types\r
1917      */
1918     private def addImplementedInterfaceFromUses(DataNodeContainer dataNodeContainer, GeneratedTypeBuilder builder) {
1919         for (usesNode : dataNodeContainer.uses) {
1920             if (usesNode.groupingPath !== null) {
1921                 val genType = findGroupingByPath(usesNode.groupingPath).toInstance
1922                 if (genType === null) {
1923                     throw new IllegalStateException(
1924                         "Grouping " + usesNode.groupingPath + "is not resolved for " + builder.name);
1925                 }
1926                 builder.addImplementsType(genType);
1927             }
1928         }
1929         return builder;
1930     }
1931
1932     private def GeneratedTypeBuilder findChildNodeByPath(SchemaPath path) {
1933         for (ctx : genCtx.values) {
1934             var result = ctx.getChildNode(path)
1935             if (result !== null) {
1936                 return result
1937             }
1938         }
1939         return null
1940     }
1941
1942     private def GeneratedTypeBuilder findGroupingByPath(SchemaPath path) {
1943         for (ctx : genCtx.values) {
1944             var result = ctx.getGrouping(path)
1945             if (result !== null) {
1946                 return result
1947             }
1948         }
1949         return null
1950     }
1951
1952     private def GeneratedTypeBuilder findCaseByPath(SchemaPath path) {
1953         for (ctx : genCtx.values) {
1954             var result = ctx.getCase(path)
1955             if (result !== null) {
1956                 return result
1957             }
1958         }
1959         return null
1960     }
1961 \r
1962 \r
1963     public def getModuleContexts() {\r
1964         genCtx;\r
1965     }
1966 }